1 <?xml version="1.0"?>
\r
4 <name>Microsoft.Extensions.FileSystemGlobbing</name>
\r
7 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase">
\r
9 Represents a directory
\r
12 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.EnumerateFileSystemInfos">
\r
14 Enumerates all files and directories in the directory.
\r
16 <returns>Collection of files and directories</returns>
\r
18 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetDirectory(System.String)">
\r
20 Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory
\r
22 <param name="path">The directory name</param>
\r
23 <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> even if directory does not exist</returns>
\r
25 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetFile(System.String)">
\r
27 Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> that represents a file in the directory
\r
29 <param name="path">The file name</param>
\r
30 <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> even if file does not exist</returns>
\r
32 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper">
\r
34 Wraps an instance of <see cref="T:System.IO.DirectoryInfo" /> and provides implementation of
\r
35 <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" />.
\r
38 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.#ctor(System.IO.DirectoryInfo)">
\r
40 Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper" />.
\r
42 <param name="directoryInfo">The <see cref="T:System.IO.DirectoryInfo" />.</param>
\r
44 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.EnumerateFileSystemInfos">
\r
47 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetDirectory(System.String)">
\r
49 Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory.
\r
52 If <paramref name="name" /> equals '..', this returns the parent directory.
\r
54 <param name="name">The directory name</param>
\r
55 <returns>The directory</returns>
\r
57 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetFile(System.String)">
\r
60 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.Name">
\r
63 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.FullName">
\r
65 Returns the full path to the directory.
\r
68 Equals the value of <seealso cref="P:System.IO.FileSystemInfo.FullName" />.
\r
71 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.ParentDirectory">
\r
73 Returns the parent directory.
\r
76 Equals the value of <seealso cref="P:System.IO.DirectoryInfo.Parent" />.
\r
79 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase">
\r
84 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper">
\r
86 Wraps an instance of <see cref="T:System.IO.FileInfo" /> to provide implementation of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" />.
\r
89 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.#ctor(System.IO.FileInfo)">
\r
91 Initializes instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper" /> to wrap the specified object <see cref="T:System.IO.FileInfo" />.
\r
93 <param name="fileInfo">The <see cref="T:System.IO.FileInfo" /></param>
\r
95 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.Name">
\r
97 The file name. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name" />).
\r
100 Equals the value of <see cref="P:System.IO.FileInfo.Name" />.
\r
103 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.FullName">
\r
105 The full path of the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName" />).
\r
108 Equals the value of <see cref="P:System.IO.FileSystemInfo.Name" />.
\r
111 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.ParentDirectory">
\r
113 The directory containing the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory" />).
\r
116 Equals the value of <see cref="P:System.IO.FileInfo.Directory" />.
\r
119 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase">
\r
121 Shared abstraction for files and directories
\r
124 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name">
\r
126 A string containing the name of the file or directory
\r
129 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName">
\r
131 A string containing the full path of the file or directory
\r
134 <member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory">
\r
136 The parent directory for the current file or directory
\r
139 <member name="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch">
\r
141 Represents a file that was matched by searching using a globbing pattern
\r
144 <member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Path">
\r
146 The path to the file matched
\r
149 If the matcher searched for "**/*.cs" using "src/Project" as the directory base and the pattern matcher found
\r
150 "src/Project/Interfaces/IFile.cs", then Stem = "Interfaces/IFile.cs" and Path = "src/Project/Interfaces/IFile.cs".
\r
153 <member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Stem">
\r
155 The subpath to the matched file under the base directory searched
\r
158 If the matcher searched for "**/*.cs" using "src/Project" as the directory base and the pattern matcher found
\r
159 "src/Project/Interfaces/IFile.cs",
\r
160 then Stem = "Interfaces/IFile.cs" and Path = "src/Project/Interfaces/IFile.cs".
\r
163 <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.#ctor(System.String,System.String)">
\r
165 Initializes new instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
\r
167 <param name="path">The path to the matched file</param>
\r
168 <param name="stem">The stem</param>
\r
170 <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)">
\r
172 Determines if the specified match is equivalent to the current match using a case-insensitive comparison.
\r
174 <param name="other">The other match to be compared</param>
\r
175 <returns>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>
\r
177 <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(System.Object)">
\r
179 Determines if the specified object is equivalent to the current match using a case-insensitive comparison.
\r
181 <param name="obj">The object to be compared</param>
\r
182 <returns>True when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)" /></returns>
\r
184 <member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.GetHashCode">
\r
186 Gets a hash for the file pattern match.
\r
188 <returns>Some number</returns>
\r
190 <member name="T:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo">
\r
192 Avoids using disk for uses like Pattern Matching.
\r
195 <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})">
\r
197 Creates a new InMemoryDirectoryInfo with the root directory and files given.
\r
199 <param name="rootDir">The root directory that this FileSystem will use.</param>
\r
200 <param name="files">Collection of file names. If relative paths <paramref name="rootDir"/> will be prepended to the paths.</param>
\r
202 <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.FullName">
\r
205 <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.Name">
\r
208 <member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.ParentDirectory">
\r
211 <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.EnumerateFileSystemInfos">
\r
214 <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetDirectory(System.String)">
\r
217 <member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetFile(System.String)">
\r
219 Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase"/> that matches the <paramref name="path"/> given.
\r
221 <param name="path">The filename.</param>
\r
222 <returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase"/> if the file exists, null otherwise.</returns>
\r
224 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.ILinearPattern">
\r
226 This API supports infrastructure and is not intended to be used
\r
227 directly from your code. This API may change or be removed in future releases.
\r
230 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.IPathSegment">
\r
232 This API supports infrastructure and is not intended to be used
\r
233 directly from your code. This API may change or be removed in future releases.
\r
236 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.IPattern">
\r
238 This API supports infrastructure and is not intended to be used
\r
239 directly from your code. This API may change or be removed in future releases.
\r
242 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.IPatternContext">
\r
244 This API supports infrastructure and is not intended to be used
\r
245 directly from your code. This API may change or be removed in future releases.
\r
248 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.IRaggedPattern">
\r
250 This API supports infrastructure and is not intended to be used
\r
251 directly from your code. This API may change or be removed in future releases.
\r
254 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.MatcherContext">
\r
256 This API supports infrastructure and is not intended to be used
\r
257 directly from your code. This API may change or be removed in future releases.
\r
260 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Internal.PatternTestResult">
\r
262 This API supports infrastructure and is not intended to be used
\r
263 directly from your code. This API may change or be removed in future releases.
\r
266 <member name="T:Microsoft.Extensions.FileSystemGlobbing.Matcher">
\r
268 Searches the file system for files with names that match specified patterns.
\r
272 Patterns specified in <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" /> and <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" /> can use
\r
273 the following formats to match multiple files or directories.
\r
275 <list type="bullet">
\r
278 exact directory and file name
\r
281 <list type="bullet">
\r
283 <term>"one.txt"</term>
\r
286 <term>"dir/two.txt"</term>
\r
293 wildcards (*) in file and directory names that represent zero to many characters not including
\r
294 directory separators characters
\r
297 <list type="bullet">
\r
299 <term>"*.txt"</term><description>all files with .txt file extension</description>
\r
302 <term>"*.*"</term><description>all files with an extension</description>
\r
305 <term>"*"</term><description>all files in top level directory</description>
\r
308 <term>".*"</term><description>filenames beginning with '.'</description>
\r
310 - "*word* - all files with 'word' in the filename
\r
312 <term>"readme.*"</term>
\r
313 <description>all files named 'readme' with any file extension</description>
\r
316 <term>"styles/*.css"</term>
\r
317 <description>all files with extension '.css' in the directory 'styles/'</description>
\r
320 <term>"scripts/*/*"</term>
\r
321 <description>all files in 'scripts/' or one level of subdirectory under 'scripts/'</description>
\r
324 <term>"images*/*"</term>
\r
325 <description>all files in a folder with name that is or begins with 'images'</description>
\r
331 <term>arbitrary directory depth ("/**/")</term>
\r
333 <list type="bullet">
\r
335 <term>"**/*"</term><description>all files in any subdirectory</description>
\r
338 <term>"dir/**/*"</term><description>all files in any subdirectory under 'dir/'</description>
\r
344 <term>relative paths</term>
\r
346 '../shared/*' - all files in a diretory named 'shared' at the sibling level to the base directory given
\r
347 to <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" />
\r
353 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor">
\r
355 Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using case-insensitive matching
\r
358 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor(System.StringComparison)">
\r
360 Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using the string comparsion method specified
\r
362 <param name="comparisonType">The <see cref="T:System.StringComparison" /> to use</param>
\r
364 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)">
\r
367 Add a file name pattern that the matcher should use to discover files. Patterns are relative to the root
\r
368 directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.
\r
371 Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
\r
372 directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.
\r
375 <param name="pattern">The globbing pattern</param>
\r
376 <returns>The matcher</returns>
\r
378 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)">
\r
381 Add a file name pattern for files the matcher should exclude from the results. Patterns are relative to the
\r
382 root directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.
\r
385 Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
\r
386 directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.
\r
389 <param name="pattern">The globbing pattern</param>
\r
390 <returns>The matcher</returns>
\r
392 <member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)">
\r
394 Searches the directory specified for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />
\r
396 <param name="directoryInfo">The root directory for the search</param>
\r
397 <returns>Always returns instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult" />, even if not files were matched</returns>
\r
399 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddExcludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
\r
401 Adds multiple exclude patterns to <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" />
\r
403 <param name="matcher">The matcher to which the exclude patterns are added</param>
\r
404 <param name="excludePatternsGroups">A list of globbing patterns</param>
\r
406 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddIncludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
\r
408 Adds multiple patterns to include in <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. See <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" />
\r
410 <param name="matcher">The matcher to which the include patterns are added</param>
\r
411 <param name="includePatternsGroups">A list of globbing patterns</param>
\r
413 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.GetResultsInFullPath(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
\r
415 Searches the directory specified for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />
\r
417 <param name="matcher">The matcher</param>
\r
418 <param name="directoryPath">The root directory for the search</param>
\r
419 <returns>Absolute file paths of all files matched. Empty enumerable if no files matched given patterns.</returns>
\r
421 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
\r
423 Matches the file passed in with the patterns in the matcher without going to disk.
\r
425 <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
\r
426 <param name="file">The file to run the matcher against.</param>
\r
427 <returns>The match results.</returns>
\r
429 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.String)">
\r
431 Matches the file passed in with the patterns in the matcher without going to disk.
\r
433 <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
\r
434 <param name="rootDir">The root directory for the matcher to match the file from.</param>
\r
435 <param name="file">The file to run the matcher against.</param>
\r
436 <returns>The match results.</returns>
\r
438 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String})">
\r
440 Matches the files passed in with the patterns in the matcher without going to disk.
\r
442 <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
\r
443 <param name="files">The files to run the matcher against.</param>
\r
444 <returns>The match results.</returns>
\r
446 <member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.Collections.Generic.IEnumerable{System.String})">
\r
448 Matches the files passed in with the patterns in the matcher without going to disk.
\r
450 <param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
\r
451 <param name="rootDir">The root directory for the matcher to match the files from.</param>
\r
452 <param name="files">The files to run the matcher against.</param>
\r
453 <returns>The match results.</returns>
\r
455 <member name="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult">
\r
457 Represents a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
\r
460 <member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch})">
\r
462 Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
\r
464 <param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
\r
466 <member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch},System.Boolean)">
\r
468 Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
\r
470 <param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
\r
471 <param name="hasMatches">A value that determines if <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult"/> has any matches.</param>
\r
473 <member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.Files">
\r
475 A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
\r
478 <member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.HasMatches">
\r
480 Gets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult"/> has any matches.
\r