Microsoft.Extensions.FileProviders.Abstractions.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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. <member name="P:System.SR.FileNotExists">
  207. <summary>The file {0} does not exist.</summary>
  208. </member>
  209. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  210. <summary>
  211. Attribute used to indicate a source generator should create a function for marshalling
  212. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  213. </summary>
  214. <remarks>
  215. This attribute is meaningless if the source generator associated with it is not enabled.
  216. The current built-in source generator only supports C# and only supplies an implementation when
  217. applied to static, partial, non-generic methods.
  218. </remarks>
  219. </member>
  220. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  221. <summary>
  222. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  223. </summary>
  224. <param name="libraryName">Name of the library containing the import.</param>
  225. </member>
  226. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  227. <summary>
  228. Gets the name of the library containing the import.
  229. </summary>
  230. </member>
  231. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  232. <summary>
  233. Gets or sets the name of the entry point to be called.
  234. </summary>
  235. </member>
  236. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  237. <summary>
  238. Gets or sets how to marshal string arguments to the method.
  239. </summary>
  240. <remarks>
  241. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  242. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  243. </remarks>
  244. </member>
  245. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  246. <summary>
  247. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  248. </summary>
  249. <remarks>
  250. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  251. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  252. </remarks>
  253. </member>
  254. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  255. <summary>
  256. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  257. on other platforms) before returning from the attributed method.
  258. </summary>
  259. </member>
  260. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  261. <summary>
  262. Specifies how strings should be marshalled for generated p/invokes
  263. </summary>
  264. </member>
  265. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  266. <summary>
  267. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  268. </summary>
  269. </member>
  270. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  271. <summary>
  272. Use the platform-provided UTF-8 marshaller.
  273. </summary>
  274. </member>
  275. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  276. <summary>
  277. Use the platform-provided UTF-16 marshaller.
  278. </summary>
  279. </member>
  280. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  281. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  282. </member>
  283. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  284. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  285. </member>
  286. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  287. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  288. </member>
  289. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  290. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  291. </member>
  292. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  293. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  294. </member>
  295. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  296. <summary>Initializes the attribute with the specified return value condition.</summary>
  297. <param name="returnValue">
  298. The return value condition. If the method returns this value, the associated parameter may be null.
  299. </param>
  300. </member>
  301. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  302. <summary>Gets the return value condition.</summary>
  303. </member>
  304. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  305. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  306. </member>
  307. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  308. <summary>Initializes the attribute with the specified return value condition.</summary>
  309. <param name="returnValue">
  310. The return value condition. If the method returns this value, the associated parameter will not be null.
  311. </param>
  312. </member>
  313. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  314. <summary>Gets the return value condition.</summary>
  315. </member>
  316. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  317. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  318. </member>
  319. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  320. <summary>Initializes the attribute with the associated parameter name.</summary>
  321. <param name="parameterName">
  322. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  323. </param>
  324. </member>
  325. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  326. <summary>Gets the associated parameter name.</summary>
  327. </member>
  328. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  329. <summary>Applied to a method that will never return under any circumstance.</summary>
  330. </member>
  331. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  332. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  333. </member>
  334. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  335. <summary>Initializes the attribute with the specified parameter value.</summary>
  336. <param name="parameterValue">
  337. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  338. the associated parameter matches this value.
  339. </param>
  340. </member>
  341. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  342. <summary>Gets the condition parameter value.</summary>
  343. </member>
  344. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  345. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  346. </member>
  347. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  348. <summary>Initializes the attribute with a field or property member.</summary>
  349. <param name="member">
  350. The field or property member that is promised to be not-null.
  351. </param>
  352. </member>
  353. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  354. <summary>Initializes the attribute with the list of field and property members.</summary>
  355. <param name="members">
  356. The list of field and property members that are promised to be not-null.
  357. </param>
  358. </member>
  359. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  360. <summary>Gets field or property member names.</summary>
  361. </member>
  362. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  363. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  364. </member>
  365. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  366. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  367. <param name="returnValue">
  368. The return value condition. If the method returns this value, the associated parameter will not be null.
  369. </param>
  370. <param name="member">
  371. The field or property member that is promised to be not-null.
  372. </param>
  373. </member>
  374. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  375. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  376. <param name="returnValue">
  377. The return value condition. If the method returns this value, the associated parameter will not be null.
  378. </param>
  379. <param name="members">
  380. The list of field and property members that are promised to be not-null.
  381. </param>
  382. </member>
  383. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  384. <summary>Gets the return value condition.</summary>
  385. </member>
  386. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  387. <summary>Gets field or property member names.</summary>
  388. </member>
  389. </members>
  390. </doc>