PhysicalFileProvider.xml

<Type Name="PhysicalFileProvider" FullName="Microsoft.Extensions.FileProviders.PhysicalFileProvider">
  <TypeSignature Language="C#" Value="public class PhysicalFileProvider : IDisposable, Microsoft.Extensions.FileProviders.IFileProvider" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PhysicalFileProvider extends System.Object implements class Microsoft.Extensions.FileProviders.IFileProvider, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider" />
  <TypeSignature Language="VB.NET" Value="Public Class PhysicalFileProvider&#xA;Implements IDisposable, IFileProvider" />
  <TypeSignature Language="F#" Value="type PhysicalFileProvider = class&#xA;    interface IFileProvider&#xA;    interface IDisposable" />
  <TypeSignature Language="C++ CLI" Value="public ref class PhysicalFileProvider : IDisposable, Microsoft::Extensions::FileProviders::IFileProvider" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>2.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.Extensions.FileProviders.IFileProvider</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Looks up files using the on-disk file system.
            </summary>
    <remarks>
            When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to
            <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> will use <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" />.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PhysicalFileProvider (string root);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string root) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (root As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Extensions.FileProviders.PhysicalFileProvider : string -&gt; Microsoft.Extensions.FileProviders.PhysicalFileProvider" Usage="new Microsoft.Extensions.FileProviders.PhysicalFileProvider root" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; PhysicalFileProvider(System::String ^ root);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="root" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="root">The root directory. This should be an absolute path.</param>
        <summary>
            Initializes a new instance of a PhysicalFileProvider at the given root directory.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PhysicalFileProvider (string root, Microsoft.Extensions.FileProviders.Physical.ExclusionFilters filters);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string root, valuetype Microsoft.Extensions.FileProviders.Physical.ExclusionFilters filters) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (root As String, filters As ExclusionFilters)" />
      <MemberSignature Language="F#" Value="new Microsoft.Extensions.FileProviders.PhysicalFileProvider : string * Microsoft.Extensions.FileProviders.Physical.ExclusionFilters -&gt; Microsoft.Extensions.FileProviders.PhysicalFileProvider" Usage="new Microsoft.Extensions.FileProviders.PhysicalFileProvider (root, filters)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; PhysicalFileProvider(System::String ^ root, Microsoft::Extensions::FileProviders::Physical::ExclusionFilters filters);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="root" Type="System.String" />
        <Parameter Name="filters" Type="Microsoft.Extensions.FileProviders.Physical.ExclusionFilters" />
      </Parameters>
      <Docs>
        <param name="root">The root directory. This should be an absolute path.</param>
        <param name="filters">Specifies which files or directories are excluded.</param>
        <summary>
            Initializes a new instance of a PhysicalFileProvider at the given root directory.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="physicalFileProvider.Dispose " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Dispose();" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Disposes the provider. Change tokens may not trigger after the provider is disposed.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose(System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="physicalFileProvider.Dispose disposing" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual void Dispose(bool disposing);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">
          <c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose" />.</param>
        <summary>
            Disposes the provider.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetDirectoryContents">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.FileProviders.IDirectoryContents GetDirectoryContents (string subpath);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.FileProviders.IDirectoryContents GetDirectoryContents(string subpath) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetDirectoryContents(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetDirectoryContents (subpath As String) As IDirectoryContents" />
      <MemberSignature Language="F#" Value="abstract member GetDirectoryContents : string -&gt; Microsoft.Extensions.FileProviders.IDirectoryContents&#xA;override this.GetDirectoryContents : string -&gt; Microsoft.Extensions.FileProviders.IDirectoryContents" Usage="physicalFileProvider.GetDirectoryContents subpath" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual Microsoft::Extensions::FileProviders::IDirectoryContents ^ GetDirectoryContents(System::String ^ subpath);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.FileProviders.IDirectoryContents</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subpath" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="subpath">A path under the root directory. Leading slashes are ignored.</param>
        <summary>
            Enumerates a directory at the given path, if any.
            </summary>
        <returns>
            The contents of the directory.
            </returns>
        <remarks>
          <para>The caller must check the <see cref="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists" /> property.</para>
          <para>Returns <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if <paramref name="subpath" /> is absolute,
            if the directory does not exist, or <paramref name="subpath" /> has invalid characters.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetFileInfo">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.FileProviders.IFileInfo GetFileInfo (string subpath);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.FileProviders.IFileInfo GetFileInfo(string subpath) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetFileInfo(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetFileInfo (subpath As String) As IFileInfo" />
      <MemberSignature Language="F#" Value="abstract member GetFileInfo : string -&gt; Microsoft.Extensions.FileProviders.IFileInfo&#xA;override this.GetFileInfo : string -&gt; Microsoft.Extensions.FileProviders.IFileInfo" Usage="physicalFileProvider.GetFileInfo subpath" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual Microsoft::Extensions::FileProviders::IFileInfo ^ GetFileInfo(System::String ^ subpath);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.FileProviders.IFileInfo</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subpath" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="subpath">A path under the root directory.</param>
        <summary>
            Locates a file at the given path by directly mapping path segments to physical directories.
            </summary>
        <returns>The file information. Caller must check the <see cref="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists" /> property.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Root">
      <MemberSignature Language="C#" Value="public string Root { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Root" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Root As String" />
      <MemberSignature Language="F#" Value="member this.Root : string" Usage="Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Root { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the root directory for this instance.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UseActivePolling">
      <MemberSignature Language="C#" Value="public bool UseActivePolling { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool UseActivePolling" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling" />
      <MemberSignature Language="VB.NET" Value="Public Property UseActivePolling As Boolean" />
      <MemberSignature Language="F#" Value="member this.UseActivePolling : bool with get, set" Usage="Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool UseActivePolling { bool get(); void set(bool value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider" />
            actively polls for file changes.
            </summary>
        <value>
          <see langword="true" /> if the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> returned by <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> actively polls for file changes
            (<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks" /> will be <see langword="true" />) instead of being passive.
            The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
            When <see langword="true" /> or <c>1</c>, this property defaults to <see langword="true" />; otherwise <see langword="false" />.
            </value>
        <remarks>
          <para>
            This property is only effective when <see cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher" /> is set.
            </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="UsePollingFileWatcher">
      <MemberSignature Language="C#" Value="public bool UsePollingFileWatcher { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool UsePollingFileWatcher" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher" />
      <MemberSignature Language="VB.NET" Value="Public Property UsePollingFileWatcher As Boolean" />
      <MemberSignature Language="F#" Value="member this.UsePollingFileWatcher : bool with get, set" Usage="Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool UsePollingFileWatcher { bool get(); void set(bool value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider" />
            uses polling to determine file changes.
            </summary>
        <value>
            The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
            When <see langword="true" /> or <c>1</c>, this property defaults to <see langword="true" />; otherwise <see langword="false" />.
            </value>
        <remarks>
            By default, <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider" />  uses <see cref="T:System.IO.FileSystemWatcher" /> to listen to file change events
            for <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" />. <see cref="T:System.IO.FileSystemWatcher" /> is ineffective in some scenarios such as mounted drives.
            Polling is required to effectively watch for file changes.
            </remarks>
        <altmember cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling" />
      </Docs>
    </Member>
    <Member MemberName="Watch">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.Primitives.IChangeToken Watch (string filter);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.Primitives.IChangeToken Watch(string filter) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function Watch (filter As String) As IChangeToken" />
      <MemberSignature Language="F#" Value="abstract member Watch : string -&gt; Microsoft.Extensions.Primitives.IChangeToken&#xA;override this.Watch : string -&gt; Microsoft.Extensions.Primitives.IChangeToken" Usage="physicalFileProvider.Watch filter" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual Microsoft::Extensions::Primitives::IChangeToken ^ Watch(System::String ^ filter);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.FileProviders.Physical</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.Primitives.IChangeToken</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="filter" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="filter">
            Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*,
            subFolder/**/*.cshtml.
            </param>
        <summary>
          <para>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</para>
          <para>Globbing patterns are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
        </summary>
        <returns>
            An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that is notified when a file matching <paramref name="filter" /> is added,
            modified, or deleted. Returns a <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /> if <paramref name="filter" /> has invalid filter
            characters or if <paramref name="filter" /> is an absolute path or outside the root directory specified in the
            constructor <seealso cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />.
            </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>