Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ internal static class StreamReaderExtensions
/// Reads a line of characters asynchronously from the current stream and returns the data as a string.
/// </summary>
/// <param name="reader">The <see cref="StreamReader"/> to read from.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask{TResult}"/> that represents the asynchronous read operation.
/// The value of the task contains the next line from the stream, or is <see langword="null"/>
Expand All @@ -31,7 +31,7 @@ internal static class StreamReaderExtensions
/// Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.
/// </summary>
/// <param name="reader">The <see cref="StreamReader"/> to read from.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="Task{TResult}"/> that represents the asynchronous read operation.
/// The value of the task contains a string with the characters from the current position to the end of the stream.
Expand Down
16 changes: 8 additions & 8 deletions src/Ramstack.FileSystem.Abstractions/VirtualDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ protected VirtualDirectory(string path, VirtualNodeProperties? properties) : bas
/// <summary>
/// Asynchronously creates the current directory.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
Expand All @@ -64,7 +64,7 @@ public ValueTask CreateAsync(CancellationToken cancellationToken = default)
/// <summary>
/// Asynchronously deletes the current directory, including all its subdirectories and files.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
Expand All @@ -79,7 +79,7 @@ public ValueTask DeleteAsync(CancellationToken cancellationToken = default)
/// <summary>
/// Asynchronously returns an async-enumerable collection of file nodes (both directories and files) within the current directory.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualNode"/> instances.
/// </returns>
Expand All @@ -89,7 +89,7 @@ public IAsyncEnumerable<VirtualNode> GetFileNodesAsync(CancellationToken cancell
/// <summary>
/// Asynchronously returns an async-enumerable collection of files within the current directory.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualFile"/> instances.
/// </returns>
Expand All @@ -99,7 +99,7 @@ public IAsyncEnumerable<VirtualFile> GetFilesAsync(CancellationToken cancellatio
/// <summary>
/// Asynchronously returns an async-enumerable collection of directories within the current directory.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualDirectory"/> instances.
/// </returns>
Expand All @@ -112,7 +112,7 @@ public IAsyncEnumerable<VirtualDirectory> GetDirectoriesAsync(CancellationToken
/// </summary>
/// <param name="patterns">An array of glob patterns to match against the names of file nodes.</param>
/// <param name="excludes">An optional array of glob patterns to exclude file nodes.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualNode"/> instances.
/// </returns>
Expand All @@ -128,7 +128,7 @@ public IAsyncEnumerable<VirtualNode> GetFileNodesAsync(string[] patterns, string
/// </summary>
/// <param name="patterns">An array of glob patterns to match against the names of files.</param>
/// <param name="excludes">An optional array of glob patterns to exclude files.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualFile"/> instances.
/// </returns>
Expand All @@ -144,7 +144,7 @@ public IAsyncEnumerable<VirtualFile> GetFilesAsync(string[] patterns, string[]?
/// </summary>
/// <param name="patterns">An array of glob patterns to match against the names of directories.</param>
/// <param name="excludes">An optional array of glob patterns to exclude directories.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualDirectory"/> instances.
/// </returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public static class VirtualDirectoryExtensions
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of file nodes.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualNode"/> instances.
/// </returns>
Expand All @@ -25,7 +25,7 @@ public static IAsyncEnumerable<VirtualNode> GetFileNodesAsync(this VirtualDirect
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of file nodes.</param>
/// <param name="exclude">An optional glob pattern to exclude certain file nodes.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualNode"/> instances.
/// </returns>
Expand All @@ -42,7 +42,7 @@ public static IAsyncEnumerable<VirtualNode> GetFileNodesAsync(this VirtualDirect
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="patterns">An array of glob patterns to match against the names of file nodes.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualNode"/> instances.
/// </returns>
Expand All @@ -55,7 +55,7 @@ public static IAsyncEnumerable<VirtualNode> GetFileNodesAsync(this VirtualDirect
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of files.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualFile"/> instances.
/// </returns>
Expand All @@ -69,7 +69,7 @@ public static IAsyncEnumerable<VirtualFile> GetFilesAsync(this VirtualDirectory
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of files.</param>
/// <param name="exclude">An optional glob pattern to exclude certain files.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualFile"/> instances.</returns>
public static IAsyncEnumerable<VirtualFile> GetFilesAsync(this VirtualDirectory directory, string pattern, string? exclude, CancellationToken cancellationToken = default)
Expand All @@ -85,7 +85,7 @@ public static IAsyncEnumerable<VirtualFile> GetFilesAsync(this VirtualDirectory
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="patterns">An array of glob patterns to match against the names of files.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualFile"/> instances.
/// </returns>
Expand All @@ -98,7 +98,7 @@ public static IAsyncEnumerable<VirtualFile> GetFilesAsync(this VirtualDirectory
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of directories.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualDirectory"/> instances.
/// </returns>
Expand All @@ -112,7 +112,7 @@ public static IAsyncEnumerable<VirtualDirectory> GetDirectoriesAsync(this Virtua
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="pattern">The glob pattern to match against the names of directories.</param>
/// <param name="exclude">An optional glob pattern to exclude certain directories.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualDirectory"/> instances.
/// </returns>
Expand All @@ -129,7 +129,7 @@ public static IAsyncEnumerable<VirtualDirectory> GetDirectoriesAsync(this Virtua
/// </summary>
/// <param name="directory">The <see cref="VirtualDirectory"/> representing the directory to search.</param>
/// <param name="patterns">An array of glob patterns to match against the names of directories.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// An async-enumerable collection of <see cref="VirtualDirectory"/> instances.
/// </returns>
Expand Down
12 changes: 6 additions & 6 deletions src/Ramstack.FileSystem.Abstractions/VirtualFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ protected VirtualFile(string path, VirtualNodeProperties? properties) : base(pat
/// <summary>
/// Asynchronously opens the file for reading.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask{TResult}"/> representing the asynchronous operation,
/// with a result of type <see cref="Stream"/> for reading the file content.
Expand All @@ -47,7 +47,7 @@ public ValueTask<Stream> OpenReadAsync(CancellationToken cancellationToken = def
/// <summary>
/// Asynchronously opens the file for writing.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask{TResult}"/> representing the asynchronous operation,
/// with a result of type <see cref="Stream"/> for writing to the file.
Expand All @@ -65,7 +65,7 @@ public ValueTask<Stream> OpenWriteAsync(CancellationToken cancellationToken = de
/// </summary>
/// <param name="stream">A <see cref="Stream"/> containing the content to write to the file.</param>
/// <param name="overwrite"><see langword="true"/> to overwrite an existing file; <see langword="false"/> to throw an exception if the file already exists.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
Expand All @@ -87,7 +87,7 @@ public ValueTask WriteAsync(Stream stream, bool overwrite, CancellationToken can
/// <summary>
/// Asynchronously deletes the current file.
/// </summary>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
Expand All @@ -104,7 +104,7 @@ public ValueTask DeleteAsync(CancellationToken cancellationToken = default)
/// </summary>
/// <param name="destinationPath">The path of the destination file. This cannot be a directory.</param>
/// <param name="overwrite"><see langword="true"/> to overwrite an existing file; <see langword="false"/> to throw an exception if the file already exists.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> representing the asynchronous operation.
/// </returns>
Expand All @@ -130,7 +130,7 @@ public ValueTask CopyToAsync(string destinationPath, bool overwrite, Cancellatio
/// </summary>
/// <param name="destination">The destination <see cref="VirtualFile"/> where the contents will be copied to.</param>
/// <param name="overwrite"><see langword="true"/> to overwrite an existing file; <see langword="false"/> to throw an exception if the file already exists.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation.</param>
/// <param name="cancellationToken">An optional cancellation token to cancel the operation. Defaults to <see cref="CancellationToken.None"/>.</param>
/// <returns>
/// A <see cref="ValueTask"/> that represents the asynchronous copy operation.
/// </returns>
Expand Down
Loading
Loading