diff --git a/src/Ramstack.FileSystem.Abstractions/Utilities/StreamReaderExtensions.cs b/src/Ramstack.FileSystem.Abstractions/Utilities/StreamReaderExtensions.cs
index 445dfa2..094f9bc 100644
--- a/src/Ramstack.FileSystem.Abstractions/Utilities/StreamReaderExtensions.cs
+++ b/src/Ramstack.FileSystem.Abstractions/Utilities/StreamReaderExtensions.cs
@@ -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.
///
/// The to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A that represents the asynchronous read operation.
/// The value of the task contains the next line from the stream, or is
@@ -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.
///
/// The to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A 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.
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualDirectory.cs b/src/Ramstack.FileSystem.Abstractions/VirtualDirectory.cs
index 55888a7..5f4556c 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualDirectory.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualDirectory.cs
@@ -49,7 +49,7 @@ protected VirtualDirectory(string path, VirtualNodeProperties? properties) : bas
///
/// Asynchronously creates the current directory.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -64,7 +64,7 @@ public ValueTask CreateAsync(CancellationToken cancellationToken = default)
///
/// Asynchronously deletes the current directory, including all its subdirectories and files.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -79,7 +79,7 @@ public ValueTask DeleteAsync(CancellationToken cancellationToken = default)
///
/// Asynchronously returns an async-enumerable collection of file nodes (both directories and files) within the current directory.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -89,7 +89,7 @@ public IAsyncEnumerable GetFileNodesAsync(CancellationToken cancell
///
/// Asynchronously returns an async-enumerable collection of files within the current directory.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -99,7 +99,7 @@ public IAsyncEnumerable GetFilesAsync(CancellationToken cancellatio
///
/// Asynchronously returns an async-enumerable collection of directories within the current directory.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -112,7 +112,7 @@ public IAsyncEnumerable GetDirectoriesAsync(CancellationToken
///
/// An array of glob patterns to match against the names of file nodes.
/// An optional array of glob patterns to exclude file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -128,7 +128,7 @@ public IAsyncEnumerable GetFileNodesAsync(string[] patterns, string
///
/// An array of glob patterns to match against the names of files.
/// An optional array of glob patterns to exclude files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -144,7 +144,7 @@ public IAsyncEnumerable GetFilesAsync(string[] patterns, string[]?
///
/// An array of glob patterns to match against the names of directories.
/// An optional array of glob patterns to exclude directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualDirectoryExtensions.cs b/src/Ramstack.FileSystem.Abstractions/VirtualDirectoryExtensions.cs
index 268911b..c48c420 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualDirectoryExtensions.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualDirectoryExtensions.cs
@@ -11,7 +11,7 @@ public static class VirtualDirectoryExtensions
///
/// The representing the directory to search.
/// The glob pattern to match against the names of file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -25,7 +25,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this VirtualDirect
/// The representing the directory to search.
/// The glob pattern to match against the names of file nodes.
/// An optional glob pattern to exclude certain file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -42,7 +42,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this VirtualDirect
///
/// The representing the directory to search.
/// An array of glob patterns to match against the names of file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -55,7 +55,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this VirtualDirect
///
/// The representing the directory to search.
/// The glob pattern to match against the names of files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -69,7 +69,7 @@ public static IAsyncEnumerable GetFilesAsync(this VirtualDirectory
/// The representing the directory to search.
/// The glob pattern to match against the names of files.
/// An optional glob pattern to exclude certain files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
public static IAsyncEnumerable GetFilesAsync(this VirtualDirectory directory, string pattern, string? exclude, CancellationToken cancellationToken = default)
@@ -85,7 +85,7 @@ public static IAsyncEnumerable GetFilesAsync(this VirtualDirectory
///
/// The representing the directory to search.
/// An array of glob patterns to match against the names of files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -98,7 +98,7 @@ public static IAsyncEnumerable GetFilesAsync(this VirtualDirectory
///
/// The representing the directory to search.
/// The glob pattern to match against the names of directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -112,7 +112,7 @@ public static IAsyncEnumerable GetDirectoriesAsync(this Virtua
/// The representing the directory to search.
/// The glob pattern to match against the names of directories.
/// An optional glob pattern to exclude certain directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -129,7 +129,7 @@ public static IAsyncEnumerable GetDirectoriesAsync(this Virtua
///
/// The representing the directory to search.
/// An array of glob patterns to match against the names of directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualFile.cs b/src/Ramstack.FileSystem.Abstractions/VirtualFile.cs
index 97bde75..c3b9891 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualFile.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualFile.cs
@@ -36,7 +36,7 @@ protected VirtualFile(string path, VirtualNodeProperties? properties) : base(pat
///
/// Asynchronously opens the file for reading.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// with a result of type for reading the file content.
@@ -47,7 +47,7 @@ public ValueTask OpenReadAsync(CancellationToken cancellationToken = def
///
/// Asynchronously opens the file for writing.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// with a result of type for writing to the file.
@@ -65,7 +65,7 @@ public ValueTask OpenWriteAsync(CancellationToken cancellationToken = de
///
/// A containing the content to write to the file.
/// to overwrite an existing file; to throw an exception if the file already exists.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -87,7 +87,7 @@ public ValueTask WriteAsync(Stream stream, bool overwrite, CancellationToken can
///
/// Asynchronously deletes the current file.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -104,7 +104,7 @@ public ValueTask DeleteAsync(CancellationToken cancellationToken = default)
///
/// The path of the destination file. This cannot be a directory.
/// to overwrite an existing file; to throw an exception if the file already exists.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -130,7 +130,7 @@ public ValueTask CopyToAsync(string destinationPath, bool overwrite, Cancellatio
///
/// The destination where the contents will be copied to.
/// to overwrite an existing file; to throw an exception if the file already exists.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A that represents the asynchronous copy operation.
///
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualFileExtensions.cs b/src/Ramstack.FileSystem.Abstractions/VirtualFileExtensions.cs
index 425eb32..f9da743 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualFileExtensions.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualFileExtensions.cs
@@ -13,7 +13,7 @@ public static class VirtualFileExtensions
/// character encoding that reads from the specified text file.
///
/// The file to get the for.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The result is a that reads from the text file.
@@ -27,7 +27,7 @@ public static ValueTask OpenTextAsync(this VirtualFile file, Cance
///
/// The file to get the for.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The result is a that reads from the text file.
@@ -43,7 +43,7 @@ public static async ValueTask OpenTextAsync(this VirtualFile file,
///
/// The file to write to.
/// A containing the content to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -54,7 +54,7 @@ public static ValueTask WriteAsync(this VirtualFile file, Stream stream, Cancell
/// Asynchronously reads all the text in the current file.
///
/// The file from which to read the entire text content.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing the full text from the current file.
@@ -67,7 +67,7 @@ public static ValueTask ReadAllTextAsync(this VirtualFile file, Cancella
///
/// The file from which to read the entire text content.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing the full text from the current file.
@@ -85,7 +85,7 @@ public static async ValueTask ReadAllTextAsync(this VirtualFile file, En
/// Asynchronously reads all lines of the current file.
///
/// The file to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of all lines in the current file.
@@ -98,7 +98,7 @@ public static ValueTask ReadAllLinesAsync(this VirtualFile file, Cance
///
/// The file to read from.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of all lines in the current file.
@@ -119,7 +119,7 @@ public static async ValueTask ReadAllLinesAsync(this VirtualFile file,
/// Asynchronously reads the entire contents of the current file into a byte array.
///
/// The file to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of the file's bytes.
@@ -209,7 +209,7 @@ static void Error_EndOfStream() =>
///
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -222,7 +222,7 @@ public static ValueTask WriteAllTextAsync(this VirtualFile file, string contents
/// The file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -234,7 +234,7 @@ public static ValueTask WriteAllTextAsync(this VirtualFile file, string contents
///
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -247,7 +247,7 @@ public static ValueTask WriteAllTextAsync(this VirtualFile file, ReadOnlyMemory<
/// The file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -263,7 +263,7 @@ public static async ValueTask WriteAllTextAsync(this VirtualFile file, ReadOnlyM
///
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -276,7 +276,7 @@ public static ValueTask WriteAllLinesAsync(this VirtualFile file, IEnumerableThe file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -294,7 +294,7 @@ public static async ValueTask WriteAllLinesAsync(this VirtualFile file, IEnumera
///
/// The file to write to.
/// The bytes to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -306,7 +306,7 @@ public static ValueTask WriteAllBytesAsync(this VirtualFile file, byte[] bytes,
///
/// The file to write to.
/// The bytes to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -321,7 +321,7 @@ public static async ValueTask WriteAllBytesAsync(this VirtualFile file, ReadOnly
///
/// The source to copy from.
/// The path of the destination file. This cannot be a directory.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -344,7 +344,7 @@ public static ValueTask CopyToAsync(this VirtualFile file, VirtualFile destinati
/// Asynchronously returns the size of the specified file in bytes.
///
/// The file to get the size of.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The result is the size of the specified file in bytes, or -1 if the file does not exist.
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.Enumeration.cs b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.Enumeration.cs
index 7661802..0079ece 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.Enumeration.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.Enumeration.cs
@@ -9,7 +9,7 @@ partial class VirtualFileSystemExtensions
/// The file system to use.
/// The path to the directory to search.
/// The glob pattern to match against the names of file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -24,7 +24,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this IVirtualFileS
/// The path to the directory to search.
/// The glob pattern to match against the names of file nodes.
/// An optional glob pattern to exclude certain file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -38,7 +38,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this IVirtualFileS
/// The file system to use.
/// The path to the directory to search.
/// An array of glob patterns to match against the names of file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -53,7 +53,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this IVirtualFileS
/// The path to the directory to search.
/// An array of glob patterns to match against the names of file nodes.
/// An optional array of glob patterns to exclude file nodes.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -66,7 +66,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this IVirtualFileS
/// The file system to use.
/// The path to the directory to search.
/// The glob pattern to match against the names of files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -80,7 +80,7 @@ public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSyste
/// The path to the directory to search.
/// The glob pattern to match against the names of files.
/// An optional glob pattern to exclude certain files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSystem fs, string path, string pattern, string? exclude, CancellationToken cancellationToken = default) =>
@@ -92,7 +92,7 @@ public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSyste
/// The file system to use.
/// The path to the directory to search.
/// An array of glob patterns to match against the names of files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -106,7 +106,7 @@ public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSyste
/// The path to the directory to search.
/// An array of glob patterns to match against the names of files.
/// An optional array of glob patterns to exclude files.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -119,7 +119,7 @@ public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSyste
/// The file system to use.
/// The path to the directory to search.
/// The glob pattern to match against the names of directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -133,7 +133,7 @@ public static IAsyncEnumerable GetDirectoriesAsync(this IVirtu
/// The path to the directory to search.
/// The glob pattern to match against the names of directories.
/// An optional glob pattern to exclude certain directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -146,7 +146,7 @@ public static IAsyncEnumerable GetDirectoriesAsync(this IVirtu
/// The file system to use.
/// The path to the directory to search.
/// An array of glob patterns to match against the names of directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -160,7 +160,7 @@ public static IAsyncEnumerable GetDirectoriesAsync(this IVirtu
/// The path to the directory to search.
/// An array of glob patterns to match against the names of directories.
/// An optional array of glob patterns to exclude directories.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs
index 59e42c2..aeff21e 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs
@@ -12,7 +12,7 @@ public static partial class VirtualFileSystemExtensions
///
/// The file system to use.
/// The path of the file to open.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation, containing a stream for reading the file content.
///
@@ -24,7 +24,7 @@ public static ValueTask OpenReadAsync(this IVirtualFileSystem fs, string
///
/// The file system to use.
/// The path of the file to open.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing a that reads from the text file.
@@ -38,7 +38,7 @@ public static Task OpenTextAsync(this IVirtualFileSystem fs, strin
/// The file system to use.
/// The path of the file to open.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing a that reads from the text file.
@@ -54,7 +54,7 @@ public static async Task OpenTextAsync(this IVirtualFileSystem fs,
///
/// The file system to use.
/// The path of the file to open or create.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation, containing a stream for writing to the file content.
///
@@ -67,7 +67,7 @@ public static ValueTask OpenWriteAsync(this IVirtualFileSystem fs, strin
/// The file system to use.
/// The path of the file.
/// A containing the content to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -82,7 +82,7 @@ public static ValueTask WriteAsync(this IVirtualFileSystem fs, string path, Stre
/// A containing the content to write to the file.
/// to overwrite an existing file;
/// to throw an exception if the file already exists.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -101,7 +101,7 @@ public static ValueTask WriteAsync(this IVirtualFileSystem fs, string path, Stre
///
/// The file system to use.
/// The file from which to read the entire text content.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing the full text from the current file.
@@ -115,7 +115,7 @@ public static ValueTask ReadAllTextAsync(this IVirtualFileSystem fs, str
/// The file system to use.
/// The file from which to read the entire text content.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing the full text from the current file.
@@ -128,7 +128,7 @@ public static ValueTask ReadAllTextAsync(this IVirtualFileSystem fs, str
///
/// The file system to use.
/// The file to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of all lines in the current file.
@@ -142,7 +142,7 @@ public static ValueTask ReadAllLinesAsync(this IVirtualFileSystem fs,
/// The file system to use.
/// The file to read from.
/// The encoding applied to the contents.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of all lines in the current file.
@@ -155,7 +155,7 @@ public static ValueTask ReadAllLinesAsync(this IVirtualFileSystem fs,
///
/// The file system to use.
/// The file to read from.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// containing an array of the file's bytes.
@@ -169,7 +169,7 @@ public static ValueTask ReadAllBytesAsync(this IVirtualFileSystem fs, st
/// The file system to use.
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -183,7 +183,7 @@ public static ValueTask WriteAllTextAsync(this IVirtualFileSystem fs, string pat
/// The file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -196,7 +196,7 @@ public static ValueTask WriteAllTextAsync(this IVirtualFileSystem fs, string pat
/// The file system to use.
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -210,7 +210,7 @@ public static ValueTask WriteAllTextAsync(this IVirtualFileSystem fs, string pat
/// The file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -223,7 +223,7 @@ public static ValueTask WriteAllTextAsync(this IVirtualFileSystem fs, string pat
/// The file system to use.
/// The file to write to.
/// The contents to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -237,7 +237,7 @@ public static ValueTask WriteAllLinesAsync(this IVirtualFileSystem fs, string pa
/// The file to write to.
/// The contents to write to the file.
/// The encoding to apply to the string.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -250,7 +250,7 @@ public static ValueTask WriteAllLinesAsync(this IVirtualFileSystem fs, string pa
/// The file system to use.
/// The file to write to.
/// The bytes to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -263,7 +263,7 @@ public static ValueTask WriteAllBytesAsync(this IVirtualFileSystem fs, string pa
/// The file system to use.
/// The file to write to.
/// The bytes to write to the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -275,7 +275,7 @@ public static ValueTask WriteAllBytesAsync(this IVirtualFileSystem fs, string pa
///
/// The file system to use.
/// The path of the file.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The task result is if the file exists; otherwise, .
@@ -284,11 +284,12 @@ public static ValueTask FileExistsAsync(this IVirtualFileSystem fs, string
fs.GetFile(path).ExistsAsync(cancellationToken);
///
- /// Asynchronously deletes the file at the specified path. No exception is thrown if the file does not exist.
+ /// Asynchronously deletes the file at the specified path.
+ /// A missing file is not considered an error.
///
/// The file system to use.
/// The path of the file to delete.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -301,7 +302,7 @@ public static ValueTask DeleteFileAsync(this IVirtualFileSystem fs, string path,
/// The file system to use.
/// The path of the file to copy.
/// The path where the file will be copied to.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -315,7 +316,7 @@ public static ValueTask CopyFileAsync(this IVirtualFileSystem fs, string path, s
/// The path of the file to copy.
/// The path where the file will be copied to.
/// to overwrite an existing file; to throw an exception if the file already exists.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -334,7 +335,7 @@ public static ValueTask CopyFileAsync(this IVirtualFileSystem fs, string path, s
///
/// The file system to use.
/// The path of the directory.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The task result is if the directory exists; otherwise, .
@@ -347,7 +348,7 @@ public static ValueTask DirectoryExistsAsync(this IVirtualFileSystem fs, s
///
/// The file system to use.
/// The path of the directory to create.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -359,7 +360,7 @@ public static ValueTask CreateDirectoryAsync(this IVirtualFileSystem fs, string
///
/// The file system to use.
/// The path of the directory to delete.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -372,7 +373,7 @@ public static ValueTask DeleteDirectoryAsync(this IVirtualFileSystem fs, string
///
/// The file system to use.
/// The path of the directory.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -384,7 +385,7 @@ public static IAsyncEnumerable GetFileNodesAsync(this IVirtualFileS
///
/// The file system to use.
/// The path of the directory.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
@@ -396,7 +397,7 @@ public static IAsyncEnumerable GetFilesAsync(this IVirtualFileSyste
///
/// The file system to use.
/// The path of the directory.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// An async-enumerable collection of instances.
///
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualNode.cs b/src/Ramstack.FileSystem.Abstractions/VirtualNode.cs
index a51a590..5dc60df 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualNode.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualNode.cs
@@ -51,7 +51,7 @@ protected VirtualNode(string path, VirtualNodeProperties? properties) : this(pat
_properties = properties;
///
- /// Refreshes the state of the file or directory node, clearing any cached or stored values.
+ /// Invalidates the node's state information so subsequent operations can retrieve updated information.
///
public void Refresh()
{
@@ -62,7 +62,7 @@ public void Refresh()
///
/// Asynchronously determines whether the file or directory exists.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
/// The task result is if the file or directory exists; otherwise, .
@@ -79,7 +79,7 @@ public ValueTask ExistsAsync(CancellationToken cancellationToken = default
/// Asynchronously retrieves the properties of the file or directory.
///
/// A boolean indicating whether to refresh the state before retrieving the properties.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// with a result of type containing the file or directory properties.
@@ -96,8 +96,7 @@ async ValueTask GetPropertiesImpl(CancellationToken token
}
///
- /// Core implementation for refreshing the state of the file or directory node,
- /// clearing any cached or stored values.
+ /// Core implementation for invalidating provider-specific state information about the file or directory node.
///
protected virtual void RefreshCore()
{
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualNodeExtensions.cs b/src/Ramstack.FileSystem.Abstractions/VirtualNodeExtensions.cs
index 3fb3f56..e2d13dc 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualNodeExtensions.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualNodeExtensions.cs
@@ -9,7 +9,7 @@ public static class VirtualNodeExtensions
/// Asynchronously retrieves the properties of the specified file or directory.
///
/// The source file or directory for which to get the .
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation,
/// with a result of type containing the node properties.
diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs b/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs
index 5648368..7234d7e 100644
--- a/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs
+++ b/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs
@@ -37,10 +37,7 @@ public static class VirtualPath
/// or an empty string if no extension is present.
///
///
- /// returns an empty string ("")
- /// if the extension consists solely of a period (e.g., "file."), which differs from
- /// , which returns "." in this case.
- /// This method follows the behavior of .
+ /// If the file name ends with a period (for example, file.), the result is empty.
///
public static string GetExtension(string path)
{
@@ -57,10 +54,7 @@ public static string GetExtension(string path)
/// or an empty string if no extension is present.
///
///
- /// returns an empty string ("")
- /// if the extension consists solely of a period (e.g., "file."), which differs from
- /// , which returns "." in this case.
- /// This method follows the behavior of .
+ /// If the file name ends with a period (for example, file.), the result is empty.
///
public static ReadOnlySpan GetExtension(ReadOnlySpan path)
{
diff --git a/src/Ramstack.FileSystem.Amazon/AmazonS3FileSystem.cs b/src/Ramstack.FileSystem.Amazon/AmazonS3FileSystem.cs
index 41f290b..810598f 100644
--- a/src/Ramstack.FileSystem.Amazon/AmazonS3FileSystem.cs
+++ b/src/Ramstack.FileSystem.Amazon/AmazonS3FileSystem.cs
@@ -108,7 +108,7 @@ public void Dispose() =>
///
/// Creates the S3 bucket if it does not already exist.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -119,7 +119,7 @@ public ValueTask CreateBucketAsync(CancellationToken cancellationToken = default
/// Creates the S3 bucket if it does not already exist.
///
/// The ACL to apply to the bucket.
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
diff --git a/src/Ramstack.FileSystem.Amazon/S3Directory.cs b/src/Ramstack.FileSystem.Amazon/S3Directory.cs
index 696e052..5123c64 100644
--- a/src/Ramstack.FileSystem.Amazon/S3Directory.cs
+++ b/src/Ramstack.FileSystem.Amazon/S3Directory.cs
@@ -318,7 +318,7 @@ protected override async IAsyncEnumerable GetDirectoriesCoreAs
/// Creates a instance based on the specified object.
///
/// The representing the file.
- /// The normalized name of the object.
+ /// The normalized name of the object. Defaults to .
///
/// A new instance representing the file.
///
diff --git a/src/Ramstack.FileSystem.Azure/AzureDirectory.cs b/src/Ramstack.FileSystem.Azure/AzureDirectory.cs
index 7cec68a..8c09e8b 100644
--- a/src/Ramstack.FileSystem.Azure/AzureDirectory.cs
+++ b/src/Ramstack.FileSystem.Azure/AzureDirectory.cs
@@ -291,7 +291,7 @@ protected override async IAsyncEnumerable GetDirectoriesCoreAs
/// Creates a instance based on the specified blob item.
///
/// The representing the file.
- /// The normalized name of the blob.
+ /// The normalized name of the blob. Defaults to .
///
/// A new instance representing the file.
///
diff --git a/src/Ramstack.FileSystem.Azure/AzureFileSystem.cs b/src/Ramstack.FileSystem.Azure/AzureFileSystem.cs
index f33d96f..5a6f0ad 100644
--- a/src/Ramstack.FileSystem.Azure/AzureFileSystem.cs
+++ b/src/Ramstack.FileSystem.Azure/AzureFileSystem.cs
@@ -57,7 +57,7 @@ public AzureFileSystem(string connectionString, string containerName, BlobClient
/// that includes the name of the account and the name of the container. This is likely to be similar
/// to https://{account_name}.blob.core.windows.net/{container_name}.
/// Optional client options that define the transport pipeline policies
- /// for authentication, retries, etc., that are applied to every request.
+ /// for authentication, retries, etc., that are applied to every request. Defaults to .
public AzureFileSystem(Uri containerUri, BlobClientOptions? options = null) =>
AzureClient = new BlobContainerClient(containerUri, options);
@@ -69,7 +69,7 @@ public AzureFileSystem(Uri containerUri, BlobClientOptions? options = null) =>
/// to https://{account_name}.blob.core.windows.net/{container_name}.
/// The shared key credential used to sign requests.
/// Optional client options that define the transport pipeline policies
- /// for authentication, retries, etc., that are applied to every request.
+ /// for authentication, retries, etc., that are applied to every request. Defaults to .
public AzureFileSystem(Uri containerUri, StorageSharedKeyCredential credential, BlobClientOptions? options = null) =>
AzureClient = new BlobContainerClient(containerUri, credential, options);
@@ -81,7 +81,7 @@ public AzureFileSystem(Uri containerUri, StorageSharedKeyCredential credential,
/// to https://{account_name}.blob.core.windows.net/{container_name}.
/// The token credential used to sign requests.
/// Optional client options that define the transport pipeline policies
- /// for authentication, retries, etc., that are applied to every request.
+ /// for authentication, retries, etc., that are applied to every request. Defaults to .
public AzureFileSystem(Uri containerUri, TokenCredential credential, BlobClientOptions? options = null) =>
AzureClient = new BlobContainerClient(containerUri, credential, options);
@@ -103,7 +103,7 @@ public VirtualFile GetFile(string path) =>
///
/// Asynchronously creates the container in Azure Blob Storage if it does not already exist.
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
@@ -134,7 +134,7 @@ public ValueTask CreateContainerAsync(CancellationToken cancellationToken = defa
///
///
///
- /// An optional cancellation token to cancel the operation.
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///
diff --git a/src/Ramstack.FileSystem.Composite/CompositeFile.cs b/src/Ramstack.FileSystem.Composite/CompositeFile.cs
index 58cdd1a..dbda80e 100644
--- a/src/Ramstack.FileSystem.Composite/CompositeFile.cs
+++ b/src/Ramstack.FileSystem.Composite/CompositeFile.cs
@@ -18,7 +18,7 @@ internal sealed class CompositeFile : VirtualFile
///
/// The file system associated with this file.
/// The path of the file.
- /// The instance to wrap.
+ /// The instance to wrap. Defaults to .
public CompositeFile(CompositeFileSystem fileSystem, string path, VirtualFile? file = null) : base(path) =>
(_fs, _file) = (fileSystem, file);
diff --git a/src/Ramstack.FileSystem.Globbing/GlobbingFileSystem.cs b/src/Ramstack.FileSystem.Globbing/GlobbingFileSystem.cs
index cfbe0c9..7beaa1f 100644
--- a/src/Ramstack.FileSystem.Globbing/GlobbingFileSystem.cs
+++ b/src/Ramstack.FileSystem.Globbing/GlobbingFileSystem.cs
@@ -32,7 +32,7 @@ public sealed class GlobbingFileSystem : IVirtualFileSystem
///
/// The underlying file system.
/// The pattern to include in the enumeration.
- /// The optional pattern to exclude from the enumeration.
+ /// The optional pattern to exclude from the enumeration. Defaults to .
public GlobbingFileSystem(IVirtualFileSystem fileSystem, string pattern, string? exclude = null)
{
ArgumentNullException.ThrowIfNull(fileSystem);
@@ -48,7 +48,7 @@ public GlobbingFileSystem(IVirtualFileSystem fileSystem, string pattern, string?
///
/// The underlying file system.
/// The patterns to include in the enumeration.
- /// The optional patterns to exclude from the enumeration.
+ /// The optional patterns to exclude from the enumeration. Defaults to .
public GlobbingFileSystem(IVirtualFileSystem fileSystem, string[] patterns, string[]? excludes = null)
{
ArgumentNullException.ThrowIfNull(fileSystem);
diff --git a/src/Ramstack.FileSystem.Google/GcsDirectory.cs b/src/Ramstack.FileSystem.Google/GcsDirectory.cs
index 3283caa..162dfea 100644
--- a/src/Ramstack.FileSystem.Google/GcsDirectory.cs
+++ b/src/Ramstack.FileSystem.Google/GcsDirectory.cs
@@ -247,7 +247,7 @@ protected override async IAsyncEnumerable GetDirectoriesCoreAs
/// Creates a instance based on the specified object item.
///
/// The representing the file.
- /// The normalized name of the object.
+ /// The normalized name of the object. Defaults to .
///
/// A new instance representing the file.
///
diff --git a/src/Ramstack.FileSystem.Google/GoogleFileSystem.cs b/src/Ramstack.FileSystem.Google/GoogleFileSystem.cs
index 96a437f..a709c47 100644
--- a/src/Ramstack.FileSystem.Google/GoogleFileSystem.cs
+++ b/src/Ramstack.FileSystem.Google/GoogleFileSystem.cs
@@ -60,8 +60,8 @@ public VirtualFile GetFile(string path) =>
/// Asynchronously creates the bucket in Google Cloud Storage if it does not already exist.
///
/// The Google Cloud project ID.
- /// Additional options for the operation.
- /// An optional cancellation token to cancel the operation.
+ /// Additional options for the operation. Defaults to .
+ /// An optional cancellation token to cancel the operation. Defaults to .
///
/// A representing the asynchronous operation.
///