e1fe331daa74f1f8dff8fb316975db6371288a84
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.Extensions.FileProviders.Abstractions</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">\r
8             <summary>\r
9             Represents a directory's content in the file provider.\r
10             </summary>\r
11         </member>\r
12         <member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">\r
13             <summary>\r
14             True if a directory was located at the given path.\r
15             </summary>\r
16         </member>\r
17         <member name="T:Microsoft.Extensions.FileProviders.IFileInfo">\r
18             <summary>\r
19             Represents a file in the given file provider.\r
20             </summary>\r
21         </member>\r
22         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">\r
23             <summary>\r
24             True if resource exists in the underlying storage system.\r
25             </summary>\r
26         </member>\r
27         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">\r
28             <summary>\r
29             The length of the file in bytes, or -1 for a directory or non-existing files.\r
30             </summary>\r
31         </member>\r
32         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">\r
33             <summary>\r
34             The path to the file, including the file name. Return null if the file is not directly accessible.\r
35             </summary>\r
36         </member>\r
37         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">\r
38             <summary>\r
39             The name of the file or directory, not including any path.\r
40             </summary>\r
41         </member>\r
42         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">\r
43             <summary>\r
44             When the file was last modified\r
45             </summary>\r
46         </member>\r
47         <member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">\r
48             <summary>\r
49             True for the case TryGetDirectoryContents has enumerated a sub-directory\r
50             </summary>\r
51         </member>\r
52         <member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">\r
53             <summary>\r
54             Return file contents as readonly stream. Caller should dispose stream when complete.\r
55             </summary>\r
56             <returns>The file stream</returns>\r
57         </member>\r
58         <member name="T:Microsoft.Extensions.FileProviders.IFileProvider">\r
59             <summary>\r
60             A read-only file provider abstraction.\r
61             </summary>\r
62         </member>\r
63         <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">\r
64             <summary>\r
65             Locate a file at the given path.\r
66             </summary>\r
67             <param name="subpath">Relative path that identifies the file.</param>\r
68             <returns>The file information. Caller must check Exists property.</returns>\r
69         </member>\r
70         <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">\r
71             <summary>\r
72             Enumerate a directory at the given path, if any.\r
73             </summary>\r
74             <param name="subpath">Relative path that identifies the directory.</param>\r
75             <returns>Returns the contents of the directory.</returns>\r
76         </member>\r
77         <member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">\r
78             <summary>\r
79             Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.\r
80             </summary>\r
81             <param name="filter">Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*, subFolder/**/*.cshtml.</param>\r
82             <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>\r
83         </member>\r
84         <member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">\r
85             <summary>\r
86             Represents a non-existing directory\r
87             </summary>\r
88         </member>\r
89         <member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">\r
90             <summary>\r
91             A shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/> \r
92             </summary>\r
93         </member>\r
94         <member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">\r
95             <summary>\r
96             Always false.\r
97             </summary>\r
98         </member>\r
99         <member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">\r
100             <summary>Returns an enumerator that iterates through the collection.</summary>\r
101             <returns>An enumerator to an empty collection.</returns>\r
102         </member>\r
103         <member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">\r
104             <inheritdoc />\r
105         </member>\r
106         <member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">\r
107             <summary>\r
108             Represents a non-existing file.\r
109             </summary>\r
110         </member>\r
111         <member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">\r
112             <summary>\r
113             Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.\r
114             </summary>\r
115             <param name="name">The name of the file that could not be found</param>\r
116         </member>\r
117         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">\r
118             <summary>\r
119             Always false.\r
120             </summary>\r
121         </member>\r
122         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">\r
123             <summary>\r
124             Always false.\r
125             </summary>\r
126         </member>\r
127         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">\r
128             <summary>\r
129             Returns <see cref="F:System.DateTimeOffset.MinValue"/>.\r
130             </summary>\r
131         </member>\r
132         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">\r
133             <summary>\r
134             Always equals -1.\r
135             </summary>\r
136         </member>\r
137         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">\r
138             <inheritdoc />\r
139         </member>\r
140         <member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">\r
141             <summary>\r
142             Always null.\r
143             </summary>\r
144         </member>\r
145         <member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">\r
146             <summary>\r
147             Always throws. A stream cannot be created for non-existing file.\r
148             </summary>\r
149             <exception cref="T:System.IO.FileNotFoundException">Always thrown.</exception>\r
150             <returns>Does not return</returns>\r
151         </member>\r
152         <member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">\r
153             <summary>\r
154             An empty change token that doesn't raise any change callbacks.\r
155             </summary>\r
156         </member>\r
157         <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">\r
158             <summary>\r
159             A singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>\r
160             </summary>\r
161         </member>\r
162         <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">\r
163             <summary>\r
164             Always false.\r
165             </summary>\r
166         </member>\r
167         <member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">\r
168             <summary>\r
169             Always false.\r
170             </summary>\r
171         </member>\r
172         <member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">\r
173             <summary>\r
174             Always returns an empty disposable object. Callbacks will never be called.\r
175             </summary>\r
176             <param name="callback">This parameter is ignored</param>\r
177             <param name="state">This parameter is ignored</param>\r
178             <returns>A disposable object that noops on dispose.</returns>\r
179         </member>\r
180         <member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">\r
181             <summary>\r
182             An empty file provider with no contents.\r
183             </summary>\r
184         </member>\r
185         <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">\r
186             <summary>\r
187             Enumerate a non-existent directory.\r
188             </summary>\r
189             <param name="subpath">A path under the root directory. This parameter is ignored.</param>\r
190             <returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>\r
191         </member>\r
192         <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">\r
193             <summary>\r
194             Locate a non-existent file.\r
195             </summary>\r
196             <param name="subpath">A path under the root directory.</param>\r
197             <returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a non-existent file at the given path.</returns>\r
198         </member>\r
199         <member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">\r
200             <summary>\r
201             Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.\r
202             </summary>\r
203             <param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>\r
204             <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>\r
205         </member>\r
206     </members>\r
207 </doc>\r