Microsoft.Extensions.FileSystemGlobbing.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.FileSystemGlobbing</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase">
  8. <summary>Represents a directory.</summary>
  9. </member>
  10. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.#ctor" />
  11. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.EnumerateFileSystemInfos">
  12. <summary>Enumerates all files and directories in the directory.</summary>
  13. <returns>Collection of files and directories</returns>
  14. </member>
  15. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetDirectory(System.String)">
  16. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory.</summary>
  17. <param name="path">The directory name</param>
  18. <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> even if directory does not exist</returns>
  19. </member>
  20. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetFile(System.String)">
  21. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> that represents a file in the directory.</summary>
  22. <param name="path">The file name</param>
  23. <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> even if file does not exist</returns>
  24. </member>
  25. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper">
  26. <summary>Wraps an instance of <see cref="T:System.IO.DirectoryInfo" /> and provides implementation of
  27. <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" />.</summary>
  28. </member>
  29. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.#ctor(System.IO.DirectoryInfo)">
  30. <summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper" />.</summary>
  31. <param name="directoryInfo">The <see cref="T:System.IO.DirectoryInfo" />.</param>
  32. </member>
  33. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.EnumerateFileSystemInfos" />
  34. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetDirectory(System.String)">
  35. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory.</summary>
  36. <param name="name">The directory name</param>
  37. <returns>The directory</returns>
  38. </member>
  39. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetFile(System.String)">
  40. <param name="name" />
  41. </member>
  42. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.FullName">
  43. <summary>Returns the full path to the directory.</summary>
  44. </member>
  45. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.Name" />
  46. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.ParentDirectory">
  47. <summary>Returns the parent directory.</summary>
  48. </member>
  49. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase">
  50. <summary>Represents a file.</summary>
  51. </member>
  52. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase.#ctor" />
  53. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper">
  54. <summary>Wraps an instance of <see cref="T:System.IO.FileInfo" /> to provide implementation of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" />.</summary>
  55. </member>
  56. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.#ctor(System.IO.FileInfo)">
  57. <summary>Initializes instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper" /> to wrap the specified object <see cref="T:System.IO.FileInfo" />.</summary>
  58. <param name="fileInfo">The <see cref="T:System.IO.FileInfo" /></param>
  59. </member>
  60. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.FullName">
  61. <summary>The full path of the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName" />).</summary>
  62. </member>
  63. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.Name">
  64. <summary>The file name. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name" />).</summary>
  65. </member>
  66. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.ParentDirectory">
  67. <summary>The directory containing the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory" />).</summary>
  68. </member>
  69. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase">
  70. <summary>Shared abstraction for files and directories.</summary>
  71. </member>
  72. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.#ctor" />
  73. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName">
  74. <summary>A string containing the full path of the file or directory.</summary>
  75. </member>
  76. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name">
  77. <summary>A string containing the name of the file or directory.</summary>
  78. </member>
  79. <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory">
  80. <summary>The parent directory for the current file or directory.</summary>
  81. </member>
  82. <member name="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch">
  83. <summary>Represents a file that was matched by searching using a globbing pattern.</summary>
  84. </member>
  85. <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.#ctor(System.String,System.String)">
  86. <summary>Initializes new instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></summary>
  87. <param name="path">The path to the matched file</param>
  88. <param name="stem">The stem</param>
  89. </member>
  90. <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)">
  91. <summary>Determines if the specified match is equivalent to the current match using a case-insensitive comparison.</summary>
  92. <param name="other">The other match to be compared</param>
  93. <returns>
  94. <see langword="true" /> if <see cref="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Path" /> and <see cref="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Stem" /> are equal using case-insensitive comparison</returns>
  95. </member>
  96. <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(System.Object)">
  97. <summary>Determines if the specified object is equivalent to the current match using a case-insensitive comparison.</summary>
  98. <param name="obj">The object to be compared</param>
  99. <returns>
  100. <see langword="true" /> when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)" /></returns>
  101. </member>
  102. <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.GetHashCode">
  103. <summary>Gets a hash for the file pattern match.</summary>
  104. <returns>Some number</returns>
  105. </member>
  106. <member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Path">
  107. <summary>The path to the file matched.</summary>
  108. </member>
  109. <member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Stem">
  110. <summary>The subpath to the matched file under the base directory searched.</summary>
  111. </member>
  112. <member name="T:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo">
  113. <summary>Avoids using disk for uses like Pattern Matching.</summary>
  114. </member>
  115. <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})">
  116. <summary>Creates a new InMemoryDirectoryInfo with the root directory and files given.</summary>
  117. <param name="rootDir">The root directory that this FileSystem will use.</param>
  118. <param name="files">Collection of file names. If relative paths <paramref name="rootDir" /> will be prepended to the paths.</param>
  119. </member>
  120. <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.EnumerateFileSystemInfos" />
  121. <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetDirectory(System.String)">
  122. <param name="path" />
  123. </member>
  124. <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetFile(System.String)">
  125. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> that matches the <paramref name="path" /> given.</summary>
  126. <param name="path">The filename.</param>
  127. <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> if the file exists, null otherwise.</returns>
  128. </member>
  129. <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.FullName" />
  130. <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.Name" />
  131. <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.ParentDirectory" />
  132. <member name="T:Microsoft.Extensions.FileSystemGlobbing.Matcher">
  133. <summary>Searches the file system for files with names that match specified patterns.</summary>
  134. </member>
  135. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor">
  136. <summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using case-insensitive matching.</summary>
  137. </member>
  138. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor(System.StringComparison)">
  139. <summary>Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using the string comparsion method specified.</summary>
  140. <param name="comparisonType">The <see cref="T:System.StringComparison" /> to use</param>
  141. </member>
  142. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)">
  143. <summary>
  144. <para>Add a file name pattern for files the matcher should exclude from the results. Patterns are relative to the
  145. root directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.</para>
  146. <para>Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
  147. directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.</para>
  148. </summary>
  149. <param name="pattern">The globbing pattern</param>
  150. <returns>The matcher</returns>
  151. </member>
  152. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)">
  153. <summary>
  154. <para>Add a file name pattern that the matcher should use to discover files. Patterns are relative to the root
  155. directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.</para>
  156. <para>Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
  157. directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.</para>
  158. </summary>
  159. <param name="pattern">The globbing pattern</param>
  160. <returns>The matcher</returns>
  161. </member>
  162. <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)">
  163. <summary>Searches the directory specified for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /></summary>
  164. <param name="directoryInfo">The root directory for the search</param>
  165. <returns>Always returns instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult" />, even if not files were matched</returns>
  166. </member>
  167. <member name="T:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions" />
  168. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddExcludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
  169. <summary>Adds multiple exclude patterns to <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</summary>
  170. <param name="matcher">The matcher to which the exclude patterns are added.</param>
  171. <param name="excludePatternsGroups">A list of globbing patterns.</param>
  172. </member>
  173. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddIncludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
  174. <summary>Adds multiple patterns to include in <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</summary>
  175. <param name="matcher">The matcher to which the include patterns are added.</param>
  176. <param name="includePatternsGroups">A list of globbing patterns.</param>
  177. </member>
  178. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.GetResultsInFullPath(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
  179. <summary>Searches the specified directory for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</summary>
  180. <param name="matcher">The matcher.</param>
  181. <param name="directoryPath">The root directory for the search.</param>
  182. <returns>Absolute file paths of all files matched. Empty enumerable if no files matched given patterns.</returns>
  183. </member>
  184. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String})">
  185. <summary>Matches the files passed in with the patterns in the matcher without going to disk.</summary>
  186. <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
  187. <param name="files">The files to run the matcher against.</param>
  188. <returns>The match results.</returns>
  189. </member>
  190. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
  191. <summary>Matches the file passed in with the patterns in the matcher without going to disk.</summary>
  192. <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
  193. <param name="file">The file to run the matcher against.</param>
  194. <returns>The match results.</returns>
  195. </member>
  196. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.Collections.Generic.IEnumerable{System.String})">
  197. <summary>Matches the files passed in with the patterns in the matcher without going to disk.</summary>
  198. <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
  199. <param name="rootDir">The root directory for the matcher to match the files from.</param>
  200. <param name="files">The files to run the matcher against.</param>
  201. <returns>The match results.</returns>
  202. </member>
  203. <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.String)">
  204. <summary>Matches the file passed in with the patterns in the matcher without going to disk.</summary>
  205. <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
  206. <param name="rootDir">The root directory for the matcher to match the file from.</param>
  207. <param name="file">The file to run the matcher against.</param>
  208. <returns>The match results.</returns>
  209. </member>
  210. <member name="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult">
  211. <summary>Represents a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></summary>
  212. </member>
  213. <member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch})">
  214. <summary>Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></summary>
  215. <param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
  216. </member>
  217. <member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch},System.Boolean)">
  218. <summary>Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></summary>
  219. <param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
  220. <param name="hasMatches">A value that determines if <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult" /> has any matches.</param>
  221. </member>
  222. <member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.Files">
  223. <summary>A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></summary>
  224. </member>
  225. <member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.HasMatches">
  226. <summary>Gets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult" /> has any matches.</summary>
  227. </member>
  228. </members>
  229. </doc>