-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathPhysicalFileProvider.xml
345 lines (345 loc) · 21.7 KB
/
PhysicalFileProvider.xml
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<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
Implements IDisposable, IFileProvider" />
<TypeSignature Language="F#" Value="type PhysicalFileProvider = class
 interface IFileProvider
 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#">[<System.Runtime.CompilerServices.Nullable(0)>]</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 -> Microsoft.Extensions.FileProviders.PhysicalFileProvider" Usage="new Microsoft.Extensions.FileProviders.PhysicalFileProvider root" />
<MemberSignature Language="C++ CLI" Value="public:
 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 -> Microsoft.Extensions.FileProviders.PhysicalFileProvider" Usage="new Microsoft.Extensions.FileProviders.PhysicalFileProvider (root, filters)" />
<MemberSignature Language="C++ CLI" Value="public:
 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 -> unit
override this.Dispose : unit -> unit" Usage="physicalFileProvider.Dispose " />
<MemberSignature Language="C++ CLI" Value="public:
 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 -> unit
override this.Dispose : bool -> unit" Usage="physicalFileProvider.Dispose disposing" />
<MemberSignature Language="C++ CLI" Value="protected:
 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 -> Microsoft.Extensions.FileProviders.IDirectoryContents
override this.GetDirectoryContents : string -> Microsoft.Extensions.FileProviders.IDirectoryContents" Usage="physicalFileProvider.GetDirectoryContents subpath" />
<MemberSignature Language="C++ CLI" Value="public:
 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 -> Microsoft.Extensions.FileProviders.IFileInfo
override this.GetFileInfo : string -> Microsoft.Extensions.FileProviders.IFileInfo" Usage="physicalFileProvider.GetFileInfo subpath" />
<MemberSignature Language="C++ CLI" Value="public:
 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:
 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:
 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:
 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 -> Microsoft.Extensions.Primitives.IChangeToken
override this.Watch : string -> Microsoft.Extensions.Primitives.IChangeToken" Usage="physicalFileProvider.Watch filter" />
<MemberSignature Language="C++ CLI" Value="public:
 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>