Microsoft.Extensions.FileProviders.Abstractions.xml 8.8 KB

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