Microsoft.Extensions.FileProviders.Embedded.xml 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.FileProviders.Embedded</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.FileProviders.EmbeddedFileProvider">
  8. <summary>
  9. Looks up files using embedded resources in the specified assembly.
  10. This file provider is case sensitive.
  11. </summary>
  12. </member>
  13. <member name="M:Microsoft.Extensions.FileProviders.EmbeddedFileProvider.#ctor(System.Reflection.Assembly)">
  14. <summary>
  15. Initializes a new instance of the <see cref="T:Microsoft.Extensions.FileProviders.EmbeddedFileProvider" /> class using the specified
  16. assembly with the base namespace defaulting to the assembly name.
  17. </summary>
  18. <param name="assembly">The assembly that contains the embedded resources.</param>
  19. </member>
  20. <member name="M:Microsoft.Extensions.FileProviders.EmbeddedFileProvider.#ctor(System.Reflection.Assembly,System.String)">
  21. <summary>
  22. Initializes a new instance of the <see cref="T:Microsoft.Extensions.FileProviders.EmbeddedFileProvider" /> class using the specified
  23. assembly and base namespace.
  24. </summary>
  25. <param name="assembly">The assembly that contains the embedded resources.</param>
  26. <param name="baseNamespace">The base namespace that contains the embedded resources.</param>
  27. </member>
  28. <member name="M:Microsoft.Extensions.FileProviders.EmbeddedFileProvider.GetFileInfo(System.String)">
  29. <summary>
  30. Locates a file at the given path.
  31. </summary>
  32. <param name="subpath">The path that identifies the file. </param>
  33. <returns>
  34. The file information. Caller must check Exists property. A <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo" /> if the file could
  35. not be found.
  36. </returns>
  37. </member>
  38. <member name="M:Microsoft.Extensions.FileProviders.EmbeddedFileProvider.GetDirectoryContents(System.String)">
  39. <summary>
  40. Enumerate a directory at the given path, if any.
  41. This file provider uses a flat directory structure. Everything under the base namespace is considered to be one
  42. directory.
  43. </summary>
  44. <param name="subpath">The path that identifies the directory</param>
  45. <returns>
  46. Contents of the directory. Caller must check Exists property. A <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if no
  47. resources were found that match <paramref name="subpath" />
  48. </returns>
  49. </member>
  50. <member name="M:Microsoft.Extensions.FileProviders.EmbeddedFileProvider.Watch(System.String)">
  51. <summary>
  52. Embedded files do not change.
  53. </summary>
  54. <param name="pattern">This parameter is ignored</param>
  55. <returns>A <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /></returns>
  56. </member>
  57. <member name="T:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo">
  58. <summary>
  59. Represents a file embedded in an assembly.
  60. </summary>
  61. </member>
  62. <member name="M:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.#ctor(System.Reflection.Assembly,System.String,System.String,System.DateTimeOffset)">
  63. <summary>
  64. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.EmbeddedFileProvider"/> for an assembly using <paramref name="resourcePath"/> as the base
  65. </summary>
  66. <param name="assembly">The assembly that contains the embedded resource</param>
  67. <param name="resourcePath">The path to the embedded resource</param>
  68. <param name="name">An arbitrary name for this instance</param>
  69. <param name="lastModified">The <see cref="T:System.DateTimeOffset" /> to use for <see cref="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.LastModified" /></param>
  70. </member>
  71. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.Exists">
  72. <summary>
  73. Always true.
  74. </summary>
  75. </member>
  76. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.Length">
  77. <summary>
  78. The length, in bytes, of the embedded resource
  79. </summary>
  80. </member>
  81. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.PhysicalPath">
  82. <summary>
  83. Always null.
  84. </summary>
  85. </member>
  86. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.Name">
  87. <summary>
  88. The name of embedded file
  89. </summary>
  90. </member>
  91. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.LastModified">
  92. <summary>
  93. The time, in UTC, when the <see cref="T:Microsoft.Extensions.FileProviders.EmbeddedFileProvider"/> was created
  94. </summary>
  95. </member>
  96. <member name="P:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.IsDirectory">
  97. <summary>
  98. Always false.
  99. </summary>
  100. </member>
  101. <member name="M:Microsoft.Extensions.FileProviders.Embedded.EmbeddedResourceFileInfo.CreateReadStream">
  102. <inheritdoc />
  103. </member>
  104. <member name="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider">
  105. <summary>
  106. An embedded file provider that uses a manifest compiled in the assembly to
  107. reconstruct the original paths of the embedded files when they were embedded
  108. into the assembly.
  109. </summary>
  110. </member>
  111. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.#ctor(System.Reflection.Assembly)">
  112. <summary>
  113. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider"/>.
  114. </summary>
  115. <param name="assembly">The assembly containing the embedded files.</param>
  116. </member>
  117. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.#ctor(System.Reflection.Assembly,System.String)">
  118. <summary>
  119. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider"/>.
  120. </summary>
  121. <param name="assembly">The assembly containing the embedded files.</param>
  122. <param name="root">The relative path from the root of the manifest to use as root for the provider.</param>
  123. </member>
  124. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.#ctor(System.Reflection.Assembly,System.String,System.DateTimeOffset)">
  125. <summary>
  126. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider"/>.
  127. </summary>
  128. <param name="assembly">The assembly containing the embedded files.</param>
  129. <param name="root">The relative path from the root of the manifest to use as root for the provider.</param>
  130. <param name="lastModified">The LastModified date to use on the <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> instances
  131. returned by this <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/>.</param>
  132. </member>
  133. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.#ctor(System.Reflection.Assembly,System.String,System.String,System.DateTimeOffset)">
  134. <summary>
  135. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider"/>.
  136. </summary>
  137. <param name="assembly">The assembly containing the embedded files.</param>
  138. <param name="root">The relative path from the root of the manifest to use as root for the provider.</param>
  139. <param name="manifestName">The name of the embedded resource containing the manifest.</param>
  140. <param name="lastModified">The LastModified date to use on the <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> instances
  141. returned by this <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/>.</param>
  142. </member>
  143. <member name="P:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.Assembly">
  144. <summary>
  145. Gets the <see cref="P:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.Assembly"/> for this provider.
  146. </summary>
  147. </member>
  148. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.GetDirectoryContents(System.String)">
  149. <inheritdoc />
  150. </member>
  151. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.GetFileInfo(System.String)">
  152. <inheritdoc />
  153. </member>
  154. <member name="M:Microsoft.Extensions.FileProviders.ManifestEmbeddedFileProvider.Watch(System.String)">
  155. <inheritdoc />
  156. </member>
  157. </members>
  158. </doc>