Microsoft.Extensions.FileProviders.Abstractions.xml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.FileProviders.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
  8. <summary>
  9. Represents a directory's content in the file provider.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
  13. <summary>
  14. True if a directory was located at the given path.
  15. </summary>
  16. </member>
  17. <member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
  18. <summary>
  19. Represents a file in the given file provider.
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
  23. <summary>
  24. True if resource exists in the underlying storage system.
  25. </summary>
  26. </member>
  27. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
  28. <summary>
  29. The length of the file in bytes, or -1 for a directory or non-existing files.
  30. </summary>
  31. </member>
  32. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
  33. <summary>
  34. The path to the file, including the file name. Return null if the file is not directly accessible.
  35. </summary>
  36. </member>
  37. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
  38. <summary>
  39. The name of the file or directory, not including any path.
  40. </summary>
  41. </member>
  42. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
  43. <summary>
  44. When the file was last modified
  45. </summary>
  46. </member>
  47. <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
  48. <summary>
  49. True for the case TryGetDirectoryContents has enumerated a sub-directory
  50. </summary>
  51. </member>
  52. <member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
  53. <summary>
  54. Return file contents as readonly stream. Caller should dispose stream when complete.
  55. </summary>
  56. <returns>The file stream</returns>
  57. </member>
  58. <member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
  59. <summary>
  60. A read-only file provider abstraction.
  61. </summary>
  62. </member>
  63. <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
  64. <summary>
  65. Locate a file at the given path.
  66. </summary>
  67. <param name="subpath">Relative path that identifies the file.</param>
  68. <returns>The file information. Caller must check Exists property.</returns>
  69. </member>
  70. <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
  71. <summary>
  72. Enumerate a directory at the given path, if any.
  73. </summary>
  74. <param name="subpath">Relative path that identifies the directory.</param>
  75. <returns>Returns the contents of the directory.</returns>
  76. </member>
  77. <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
  78. <summary>
  79. Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
  80. </summary>
  81. <param name="filter">Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
  82. <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>
  83. </member>
  84. <member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
  85. <summary>
  86. Represents a non-existing directory
  87. </summary>
  88. </member>
  89. <member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
  90. <summary>
  91. A shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>
  92. </summary>
  93. </member>
  94. <member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
  95. <summary>
  96. Always false.
  97. </summary>
  98. </member>
  99. <member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
  100. <summary>Returns an enumerator that iterates through the collection.</summary>
  101. <returns>An enumerator to an empty collection.</returns>
  102. </member>
  103. <member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
  104. <inheritdoc />
  105. </member>
  106. <member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
  107. <summary>
  108. Represents a non-existing file.
  109. </summary>
  110. </member>
  111. <member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
  112. <summary>
  113. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
  114. </summary>
  115. <param name="name">The name of the file that could not be found</param>
  116. </member>
  117. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
  118. <summary>
  119. Always false.
  120. </summary>
  121. </member>
  122. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
  123. <summary>
  124. Always false.
  125. </summary>
  126. </member>
  127. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
  128. <summary>
  129. Returns <see cref="F:System.DateTimeOffset.MinValue"/>.
  130. </summary>
  131. </member>
  132. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
  133. <summary>
  134. Always equals -1.
  135. </summary>
  136. </member>
  137. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
  138. <inheritdoc />
  139. </member>
  140. <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
  141. <summary>
  142. Always null.
  143. </summary>
  144. </member>
  145. <member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
  146. <summary>
  147. Always throws. A stream cannot be created for non-existing file.
  148. </summary>
  149. <exception cref="T:System.IO.FileNotFoundException">Always thrown.</exception>
  150. <returns>Does not return</returns>
  151. </member>
  152. <member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
  153. <summary>
  154. An empty change token that doesn't raise any change callbacks.
  155. </summary>
  156. </member>
  157. <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
  158. <summary>
  159. A singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>
  160. </summary>
  161. </member>
  162. <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
  163. <summary>
  164. Always false.
  165. </summary>
  166. </member>
  167. <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
  168. <summary>
  169. Always false.
  170. </summary>
  171. </member>
  172. <member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  173. <summary>
  174. Always returns an empty disposable object. Callbacks will never be called.
  175. </summary>
  176. <param name="callback">This parameter is ignored</param>
  177. <param name="state">This parameter is ignored</param>
  178. <returns>A disposable object that noops on dispose.</returns>
  179. </member>
  180. <member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
  181. <summary>
  182. An empty file provider with no contents.
  183. </summary>
  184. </member>
  185. <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
  186. <summary>
  187. Enumerate a non-existent directory.
  188. </summary>
  189. <param name="subpath">A path under the root directory. This parameter is ignored.</param>
  190. <returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
  191. </member>
  192. <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
  193. <summary>
  194. Locate a non-existent file.
  195. </summary>
  196. <param name="subpath">A path under the root directory.</param>
  197. <returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a non-existent file at the given path.</returns>
  198. </member>
  199. <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
  200. <summary>
  201. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
  202. </summary>
  203. <param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
  204. <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
  205. </member>
  206. </members>
  207. </doc>