Microsoft.Extensions.FileProviders.Physical.xml 19 KB

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