123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.Extensions.FileProviders.Physical</name>
- </assembly>
- <members>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters">
- <summary>
- Specifies filtering behavior for files or directories.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Sensitive">
- <summary>
- Equivalent to <c>DotPrefixed | Hidden | System</c>. Exclude files and directories when the name begins with a period, or has either <see cref="F:System.IO.FileAttributes.Hidden"/> or <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.DotPrefixed">
- <summary>
- Exclude files and directories when the name begins with period.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Hidden">
- <summary>
- Exclude files and directories when <see cref="F:System.IO.FileAttributes.Hidden"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.System">
- <summary>
- Exclude files and directories when <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
- </summary>
- </member>
- <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.None">
- <summary>
- Do not exclude any files.
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
- <summary>
- Represents a directory on a physical filesystem
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.#ctor(System.IO.DirectoryInfo)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo"/> that wraps an instance of <see cref="T:System.IO.DirectoryInfo"/>
- </summary>
- <param name="info">The directory</param>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Exists">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Length">
- <summary>
- Always equals -1.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.PhysicalPath">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Name">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.LastModified">
- <summary>
- The time when the directory was last written to.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.IsDirectory">
- <summary>
- Always true.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.CreateReadStream">
- <summary>
- Always throws an exception because read streams are not support on directories.
- </summary>
- <exception cref="T:System.InvalidOperationException">Always thrown</exception>
- <returns>Never returns</returns>
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
- <summary>
- Represents a file on a physical filesystem
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.#ctor(System.IO.FileInfo)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo"/> that wraps an instance of <see cref="T:System.IO.FileInfo"/>
- </summary>
- <param name="info">The <see cref="T:System.IO.FileInfo"/></param>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Exists">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Length">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.PhysicalPath">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Name">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.LastModified">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.IsDirectory">
- <summary>
- Always false.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.CreateReadStream">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher">
- <summary>
- <para>
- A file watcher that watches a physical filesystem for changes.
- </para>
- <para>
- Triggers events on <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> when files are created, change, renamed, or deleted.
- </para>
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
- Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
- </summary>
- <param name="root">Root directory for the watcher</param>
- <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
- <param name="pollForChanges">
- True when the watcher should use polling to trigger instances of
- <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
- </param>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
- Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
- </summary>
- <param name="root">Root directory for the watcher</param>
- <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
- <param name="pollForChanges">
- True when the watcher should use polling to trigger instances of
- <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
- </param>
- <param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)">
- <summary>
- <para>
- Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the
- <paramref name="filter" />
- </para>
- <para>
- Globbing patterns are relative to the root directory given in the constructor
- <seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns
- are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.
- </para>
- </summary>
- <param name="filter">A globbing pattern for files and directories to watch</param>
- <returns>A change token for all files that match the filter</returns>
- <exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose">
- <summary>
- Disposes the file watcher
- </summary>
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken">
- <summary>
- <para>
- A change token that polls for file system changes.
- </para>
- <para>
- This change token does not raise any change callbacks. Callers should watch for <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> to turn
- from false to true
- and dispose the token after this happens.
- </para>
- </summary>
- <remarks>
- Polling occurs every 4 seconds.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.#ctor(System.IO.FileInfo)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" /> that polls the specified file for changes as
- determined by <see cref="P:System.IO.FileSystemInfo.LastWriteTimeUtc" />.
- </summary>
- <param name="fileInfo">The <see cref="T:System.IO.FileInfo"/> to poll</param>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.ActiveChangeCallbacks">
- <summary>
- Always false.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged">
- <summary>
- True when the file has changed since the change token was created. Once the file changes, this value is always true
- </summary>
- <remarks>
- Once true, the value will always be true. Change tokens should not re-used once expired. The caller should discard this
- instance once it sees <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> is true.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
- <summary>
- Does not actually register callbacks.
- </summary>
- <param name="callback">This parameter is ignored</param>
- <param name="state">This parameter is ignored</param>
- <returns>A disposable object that noops when disposed</returns>
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
- <summary>
- A polling based <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for wildcard patterns.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken"/>.
- </summary>
- <param name="root">The root of the file system.</param>
- <param name="pattern">The pattern to watch.</param>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks">
- <inheritdoc />
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.GetLastWriteUtc(System.String)">
- <summary>
- Gets the last write time of the file at the specified <paramref name="path"/>.
- </summary>
- <param name="path">The root relative path.</param>
- <returns>The <see cref="T:System.DateTime"/> that the file was last modified.</returns>
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
- <summary>
- Represents the contents of a physical file directory
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
- </summary>
- <param name="directory">The directory</param>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
- <summary>
- Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
- </summary>
- <param name="directory">The directory</param>
- <param name="filters">Specifies which files or directories are excluded from enumeration.</param>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.Exists">
- <inheritdoc />
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.GetEnumerator">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider">
- <summary>
- Looks up files using the on-disk file system
- </summary>
- <remarks>
- When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to
- <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> will use <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" />.
- </remarks>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)">
- <summary>
- Initializes a new instance of a PhysicalFileProvider at the given root directory.
- </summary>
- <param name="root">The root directory. This should be an absolute path.</param>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
- <summary>
- Initializes a new instance of a PhysicalFileProvider at the given root directory.
- </summary>
- <param name="root">The root directory. This should be an absolute path.</param>
- <param name="filters">Specifies which files or directories are excluded.</param>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose">
- <summary>
- Disposes the provider. Change tokens may not trigger after the provider is disposed.
- </summary>
- </member>
- <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root">
- <summary>
- The root directory for this instance.
- </summary>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetFileInfo(System.String)">
- <summary>
- Locate a file at the given path by directly mapping path segments to physical directories.
- </summary>
- <param name="subpath">A path under the root directory</param>
- <returns>The file information. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists"/> property. </returns>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetDirectoryContents(System.String)">
- <summary>
- Enumerate a directory at the given path, if any.
- </summary>
- <param name="subpath">A path under the root directory. Leading slashes are ignored.</param>
- <returns>
- Contents of the directory. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists"/> property. <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if
- <paramref name="subpath" /> is absolute, if the directory does not exist, or <paramref name="subpath" /> has invalid
- characters.
- </returns>
- </member>
- <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)">
- <summary>
- <para>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</para>
- <para>Globbing patterns are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
- </summary>
- <param name="filter">
- Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*,
- subFolder/**/*.cshtml.
- </param>
- <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 a <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /> if <paramref name="filter" /> has invalid filter
- characters or if <paramref name="filter" /> is an absolute path or outside the root directory specified in the
- constructor <seealso cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />.
- </returns>
- </member>
- </members>
- </doc>
|