Microsoft.Owin.FileSystems.XML 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.FileSystems</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem">
  8. <summary>
  9. Looks up files using embedded resources in the specified assembly.
  10. This file system is case sensitive.
  11. </summary>
  12. </member>
  13. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.#ctor">
  14. <summary>
  15. Initializes a new instance of the <see cref="T:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem" /> class using the calling
  16. assembly and empty base namespace.
  17. </summary>
  18. </member>
  19. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.#ctor(System.Reflection.Assembly)">
  20. <summary>
  21. Initializes a new instance of the <see cref="T:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem" /> class using the specified
  22. assembly and empty base namespace.
  23. </summary>
  24. <param name="assembly"></param>
  25. </member>
  26. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.#ctor(System.String)">
  27. <summary>
  28. Initializes a new instance of the <see cref="T:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem" /> class using the calling
  29. assembly and specified base namespace.
  30. </summary>
  31. <param name="baseNamespace">The base namespace that contains the embedded resources.</param>
  32. </member>
  33. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.#ctor(System.Reflection.Assembly,System.String)">
  34. <summary>
  35. Initializes a new instance of the <see cref="T:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem" /> class using the specified
  36. assembly and base namespace.
  37. </summary>
  38. <param name="assembly">The assembly that contains the embedded resources.</param>
  39. <param name="baseNamespace">The base namespace that contains the embedded resources.</param>
  40. </member>
  41. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.TryGetFileInfo(System.String,Microsoft.Owin.FileSystems.IFileInfo@)">
  42. <summary>
  43. Locate a file at the given path
  44. </summary>
  45. <param name="subpath">The path that identifies the file</param>
  46. <param name="fileInfo">The discovered file if any</param>
  47. <returns>True if a file was located at the given path</returns>
  48. </member>
  49. <member name="M:Microsoft.Owin.FileSystems.EmbeddedResourceFileSystem.TryGetDirectoryContents(System.String,System.Collections.Generic.IEnumerable{Microsoft.Owin.FileSystems.IFileInfo}@)">
  50. <summary>
  51. Enumerate a directory at the given path, if any.
  52. This file system uses a flat directory structure. Everything under the base namespace is considered to be one directory.
  53. </summary>
  54. <param name="subpath">The path that identifies the directory</param>
  55. <param name="contents">The contents if any</param>
  56. <returns>True if a directory was located at the given path</returns>
  57. </member>
  58. <member name="T:Microsoft.Owin.FileSystems.IFileInfo">
  59. <summary>
  60. Represents a file in the given file system.
  61. </summary>
  62. </member>
  63. <member name="P:Microsoft.Owin.FileSystems.IFileInfo.Length">
  64. <summary>
  65. The length of the file in bytes, or -1 for a directory info
  66. </summary>
  67. </member>
  68. <member name="P:Microsoft.Owin.FileSystems.IFileInfo.PhysicalPath">
  69. <summary>
  70. The path to the file, including the file name. Return null if the file is not directly accessible.
  71. </summary>
  72. </member>
  73. <member name="P:Microsoft.Owin.FileSystems.IFileInfo.Name">
  74. <summary>
  75. The name of the file
  76. </summary>
  77. </member>
  78. <member name="P:Microsoft.Owin.FileSystems.IFileInfo.LastModified">
  79. <summary>
  80. When the file was last modified
  81. </summary>
  82. </member>
  83. <member name="P:Microsoft.Owin.FileSystems.IFileInfo.IsDirectory">
  84. <summary>
  85. True for the case TryGetDirectoryContents has enumerated a sub-directory
  86. </summary>
  87. </member>
  88. <member name="M:Microsoft.Owin.FileSystems.IFileInfo.CreateReadStream">
  89. <summary>
  90. Return file contents as readonly stream. Caller should dispose stream when complete.
  91. </summary>
  92. <returns>The file stream</returns>
  93. </member>
  94. <member name="T:Microsoft.Owin.FileSystems.IFileSystem">
  95. <summary>
  96. A file system abstraction
  97. </summary>
  98. </member>
  99. <member name="M:Microsoft.Owin.FileSystems.IFileSystem.TryGetFileInfo(System.String,Microsoft.Owin.FileSystems.IFileInfo@)">
  100. <summary>
  101. Locate a file at the given path
  102. </summary>
  103. <param name="subpath">The path that identifies the file</param>
  104. <param name="fileInfo">The discovered file if any</param>
  105. <returns>True if a file was located at the given path</returns>
  106. </member>
  107. <member name="M:Microsoft.Owin.FileSystems.IFileSystem.TryGetDirectoryContents(System.String,System.Collections.Generic.IEnumerable{Microsoft.Owin.FileSystems.IFileInfo}@)">
  108. <summary>
  109. Enumerate a directory at the given path, if any
  110. </summary>
  111. <param name="subpath">The path that identifies the directory</param>
  112. <param name="contents">The contents if any</param>
  113. <returns>True if a directory was located at the given path</returns>
  114. </member>
  115. <member name="T:Microsoft.Owin.FileSystems.PhysicalFileSystem">
  116. <summary>
  117. Looks up files using the on-disk file system
  118. </summary>
  119. </member>
  120. <member name="M:Microsoft.Owin.FileSystems.PhysicalFileSystem.#ctor(System.String)">
  121. <summary>
  122. Creates a new instance of a PhysicalFileSystem at the given root directory.
  123. </summary>
  124. <param name="root">The root directory</param>
  125. </member>
  126. <member name="P:Microsoft.Owin.FileSystems.PhysicalFileSystem.Root">
  127. <summary>
  128. The root directory for this instance.
  129. </summary>
  130. </member>
  131. <member name="M:Microsoft.Owin.FileSystems.PhysicalFileSystem.TryGetFileInfo(System.String,Microsoft.Owin.FileSystems.IFileInfo@)">
  132. <summary>
  133. Locate a file at the given path by directly mapping path segments to physical directories.
  134. </summary>
  135. <param name="subpath">A path under the root directory</param>
  136. <param name="fileInfo">The discovered file, if any</param>
  137. <returns>True if a file was discovered at the given path</returns>
  138. </member>
  139. <member name="M:Microsoft.Owin.FileSystems.PhysicalFileSystem.TryGetDirectoryContents(System.String,System.Collections.Generic.IEnumerable{Microsoft.Owin.FileSystems.IFileInfo}@)">
  140. <summary>
  141. Enumerate a directory at the given path, if any.
  142. </summary>
  143. <param name="subpath">A path under the root directory</param>
  144. <param name="contents">The discovered directories, if any</param>
  145. <returns>True if a directory was discovered at the given path</returns>
  146. </member>
  147. </members>
  148. </doc>