projects / platform / core / dotnet / build-tools.git / blob
? search:


824d76c307c3e800c5c12fe1920776ea5d5c1dc8
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.Extensions.FileProviders.Physical</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters">\r
8             <summary>\r
9             Specifies filtering behavior for files or directories.\r
10             </summary>\r
11         </member>\r
12         <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Sensitive">\r
13             <summary>\r
14             Equivalent to <c>DotPrefixed | Hidden | System</c>. Exclude files and directories when the name begins with a period, or has either <see cref="F:System.IO.FileAttributes.Hidden"/> or <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.\r
15             </summary>\r
16         </member>\r
17         <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.DotPrefixed">\r
18             <summary>\r
19             Exclude files and directories when the name begins with period.\r
20             </summary>\r
21         </member>\r
22         <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Hidden">\r
23             <summary>\r
24             Exclude files and directories when <see cref="F:System.IO.FileAttributes.Hidden"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.\r
25             </summary>\r
26         </member>\r
27         <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.System">\r
28             <summary>\r
29             Exclude files and directories when <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.\r
30             </summary>\r
31         </member>\r
32         <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.None">\r
33             <summary>\r
34             Do not exclude any files.\r
35             </summary>\r
36         </member>\r
37         <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">\r
38             <summary>\r
39             Represents a directory on a physical filesystem\r
40             </summary>\r
41         </member>\r
42         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.#ctor(System.IO.DirectoryInfo)">\r
43             <summary>\r
44             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo"/> that wraps an instance of <see cref="T:System.IO.DirectoryInfo"/>\r
45             </summary>\r
46             <param name="info">The directory</param>\r
47         </member>\r
48         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Exists">\r
49             <inheritdoc />\r
50         </member>\r
51         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Length">\r
52             <summary>\r
53             Always equals -1.\r
54             </summary>\r
55         </member>\r
56         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.PhysicalPath">\r
57             <inheritdoc />\r
58         </member>\r
59         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Name">\r
60             <inheritdoc />\r
61         </member>\r
62         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.LastModified">\r
63             <summary>\r
64             The time when the directory was last written to.\r
65             </summary>\r
66         </member>\r
67         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.IsDirectory">\r
68             <summary>\r
69             Always true.\r
70             </summary>\r
71         </member>\r
72         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.CreateReadStream">\r
73             <summary>\r
74             Always throws an exception because read streams are not support on directories.\r
75             </summary>\r
76             <exception cref="T:System.InvalidOperationException">Always thrown</exception>\r
77             <returns>Never returns</returns>\r
78         </member>\r
79         <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">\r
80             <summary>\r
81             Represents a file on a physical filesystem\r
82             </summary>\r
83         </member>\r
84         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.#ctor(System.IO.FileInfo)">\r
85             <summary>\r
86             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo"/> that wraps an instance of <see cref="T:System.IO.FileInfo"/>\r
87             </summary>\r
88             <param name="info">The <see cref="T:System.IO.FileInfo"/></param>\r
89         </member>\r
90         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Exists">\r
91             <inheritdoc />\r
92         </member>\r
93         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Length">\r
94             <inheritdoc />\r
95         </member>\r
96         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.PhysicalPath">\r
97             <inheritdoc />\r
98         </member>\r
99         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Name">\r
100             <inheritdoc />\r
101         </member>\r
102         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.LastModified">\r
103             <inheritdoc />\r
104         </member>\r
105         <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.IsDirectory">\r
106             <summary>\r
107             Always false.\r
108             </summary>\r
109         </member>\r
110         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.CreateReadStream">\r
111             <inheritdoc />\r
112         </member>\r
113         <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher">\r
114             <summary>\r
115                 <para>\r
116                 A file watcher that watches a physical filesystem for changes.\r
117                 </para>\r
118                 <para>\r
119                 Triggers events on <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> when files are created, change, renamed, or deleted.\r
120                 </para>\r
121             </summary>\r
122         </member>\r
123         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)">\r
124             <summary>\r
125             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.\r
126             Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />\r
127             </summary>\r
128             <param name="root">Root directory for the watcher</param>\r
129             <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>\r
130             <param name="pollForChanges">\r
131             True when the watcher should use polling to trigger instances of\r
132             <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />\r
133             </param>\r
134         </member>\r
135         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">\r
136             <summary>\r
137             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.\r
138             Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />\r
139             </summary>\r
140             <param name="root">Root directory for the watcher</param>\r
141             <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>\r
142             <param name="pollForChanges">\r
143             True when the watcher should use polling to trigger instances of\r
144             <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />\r
145             </param>\r
146             <param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>\r
147         </member>\r
148         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)">\r
149             <summary>\r
150                 <para>\r
151                 Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the\r
152                 <paramref name="filter" />\r
153                 </para>\r
154                 <para>\r
155                 Globbing patterns are relative to the root directory given in the constructor\r
156                 <seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns\r
157                 are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.\r
158                 </para>\r
159             </summary>\r
160             <param name="filter">A globbing pattern for files and directories to watch</param>\r
161             <returns>A change token for all files that match the filter</returns>\r
162             <exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>\r
163         </member>\r
164         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose">\r
165             <summary>\r
166             Disposes the provider. Change tokens may not trigger after the provider is disposed.\r
167             </summary>\r
168         </member>\r
169         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose(System.Boolean)">\r
170             <summary>\r
171             Disposes the provider.\r
172             </summary>\r
173             <param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>\r
174         </member>\r
175         <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Finalize">\r
176             <summary>\r
177             Destructor for <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher"/>.\r
178             </summary>\r
179         </member>\r
180         <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken">\r
181             <summary>\r
182                 <para>\r
183                 A change token that polls for file system changes.\r
184                 </para>\r
185                 <para>\r
186                 This change token does not raise any change callbacks. Callers should watch for <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> to turn\r
187                 from false to true\r
188                 and dispose the token after this happens.\r
189                 </para>\r
190             </summary>\r
191             <remarks>\r
192             Polling occurs every 4 seconds.\r
193             </remarks>\r
194         </member>\r
195         <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.#ctor(System.IO.FileInfo)">\r
196             <summary>\r
197             Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" /> that polls the specified file for changes as\r
198             determined by <see cref="P:System.IO.FileSystemInfo.LastWriteTimeUtc" />.\r
199             </summary>\r
200             <param name="fileInfo">The <see cref="T:System.IO.FileInfo"/> to poll</param>\r
201         </member>\r
202         <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.ActiveChangeCallbacks">\r
203             <summary>\r
204             Always false.\r
205             </summary>\r
206         </member>\r
207         <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged">\r
208             <summary>\r
209             True when the file has changed since the change token was created. Once the file changes, this value is always true\r
210             </summary>\r
211             <remarks>\r
212             Once true, the value will always be true. Change tokens should not re-used once expired. The caller should discard this\r
213             instance once it sees <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> is true.\r
214             </remarks>\r
215         </member>\r
216         <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">\r
217             <summary>\r
218             Does not actually register callbacks.\r
219             </summary>\r
220             <param name="callback">This parameter is ignored</param>\r
221             <param name="state">This parameter is ignored</param>\r
222             <returns>A disposable object that noops when disposed</returns>\r
223         </member>\r
224         <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">\r
225             <summary>\r
226             A polling based <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for wildcard patterns.\r
227             </summary>\r
228         </member>\r
229         <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.#ctor(System.String,System.String)">\r
230             <summary>\r
231             Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken"/>.\r
232             </summary>\r
233             <param name="root">The root of the file system.</param>\r
234             <param name="pattern">The pattern to watch.</param>\r
235         </member>\r
236         <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks">\r
237             <inheritdoc />\r
238         </member>\r
239         <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged">\r
240             <inheritdoc />\r
241         </member>\r
242         <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.GetLastWriteUtc(System.String)">\r
243             <summary>\r
244             Gets the last write time of the file at the specified <paramref name="path"/>.\r
245             </summary>\r
246             <param name="path">The root relative path.</param>\r
247             <returns>The <see cref="T:System.DateTime"/> that the file was last modified.</returns>\r
248         </member>\r
249         <member name="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">\r
250             <summary>\r
251             Represents the contents of a physical file directory\r
252             </summary>\r
253         </member>\r
254         <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String)">\r
255             <summary>\r
256             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>\r
257             </summary>\r
258             <param name="directory">The directory</param>\r
259         </member>\r
260         <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">\r
261             <summary>\r
262             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>\r
263             </summary>\r
264             <param name="directory">The directory</param>\r
265             <param name="filters">Specifies which files or directories are excluded from enumeration.</param>\r
266         </member>\r
267         <member name="P:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.Exists">\r
268             <inheritdoc />\r
269         </member>\r
270         <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.GetEnumerator">\r
271             <inheritdoc />\r
272         </member>\r
273         <member name="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider">\r
274             <summary>\r
275             Looks up files using the on-disk file system\r
276             </summary>\r
277             <remarks>\r
278             When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to\r
279             <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> will use <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" />.\r
280             </remarks>\r
281         </member>\r
282         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)">\r
283             <summary>\r
284             Initializes a new instance of a PhysicalFileProvider at the given root directory.\r
285             </summary>\r
286             <param name="root">The root directory. This should be an absolute path.</param>\r
287         </member>\r
288         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">\r
289             <summary>\r
290             Initializes a new instance of a PhysicalFileProvider at the given root directory.\r
291             </summary>\r
292             <param name="root">The root directory. This should be an absolute path.</param>\r
293             <param name="filters">Specifies which files or directories are excluded.</param>\r
294         </member>\r
295         <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher">\r
296             <summary>\r
297             Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>\r
298             uses polling to determine file changes.\r
299             <para>\r
300             By default, <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>  uses <see cref="T:System.IO.FileSystemWatcher"/> to listen to file change events\r
301             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.\r
302             Polling is required to effectively watch for file changes.\r
303             </para>\r
304             <seealso cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling"/>.\r
305             </summary>\r
306             <value>\r
307             The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.\r
308             When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.\r
309             </value>\r
310         </member>\r
311         <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling">\r
312             <summary>\r
313             Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>\r
314             actively polls for file changes.\r
315             <para>\r
316             When <see langword="true"/>, <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> returned by <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)"/> will actively poll for file changes\r
317             (<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks"/> will be <see langword="true"/>) instead of being passive.\r
318             </para>\r
319             <para>\r
320             This property is only effective when <see cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher"/> is set.\r
321             </para>\r
322             </summary>\r
323             <value>\r
324             The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.\r
325             When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.\r
326             </value>\r
327         </member>\r
328         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose">\r
329             <summary>\r
330             Disposes the provider. Change tokens may not trigger after the provider is disposed.\r
331             </summary>\r
332         </member>\r
333         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose(System.Boolean)">\r
334             <summary>\r
335             Disposes the provider.\r
336             </summary>\r
337             <param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>\r
338         </member>\r
339         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Finalize">\r
340             <summary>\r
341             Destructor for <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>.\r
342             </summary>\r
343         </member>\r
344         <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root">\r
345             <summary>\r
346             The root directory for this instance.\r
347             </summary>\r
348         </member>\r
349         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetFileInfo(System.String)">\r
350             <summary>\r
351             Locate a file at the given path by directly mapping path segments to physical directories.\r
352             </summary>\r
353             <param name="subpath">A path under the root directory</param>\r
354             <returns>The file information. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists"/> property. </returns>\r
355         </member>\r
356         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetDirectoryContents(System.String)">\r
357             <summary>\r
358             Enumerate a directory at the given path, if any.\r
359             </summary>\r
360             <param name="subpath">A path under the root directory. Leading slashes are ignored.</param>\r
361             <returns>\r
362             Contents of the directory. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists"/> property. <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if\r
363             <paramref name="subpath" /> is absolute, if the directory does not exist, or <paramref name="subpath" /> has invalid\r
364             characters.\r
365             </returns>\r
366         </member>\r
367         <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)">\r
368             <summary>\r
369                 <para>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</para>\r
370                 <para>Globbing patterns are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>\r
371             </summary>\r
372             <param name="filter">\r
373             Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*,\r
374             subFolder/**/*.cshtml.\r
375             </param>\r
376             <returns>\r
377             An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that is notified when a file matching <paramref name="filter" /> is added,\r
378             modified or deleted. Returns a <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /> if <paramref name="filter" /> has invalid filter\r
379             characters or if <paramref name="filter" /> is an absolute path or outside the root directory specified in the\r
380             constructor <seealso cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />.\r
381             </returns>\r
382         </member>\r
383     </members>\r
384 </doc>\r
Domain: Dotnet / Common;