Update TempFile.cs

Author: SimonCropp

src/Verify/TempFile.cs

@@ -146,6 +146,43 @@ public TempFile(string? extension = null)
         }
     }
 
+    /// <summary>
+    /// Creates a new temporary file with optional extension and encoding.
+    /// </summary>
+    /// <param name="extension">
+    /// Optional file extension (e.g., ".txt", ".json").
+    /// If not provided, no extension is added.
+    /// The extension should include the leading dot.
+    /// </param>
+    /// <param name="encoding">
+    /// Optional text encoding to use when creating the file.
+    /// If provided and the extension is recognized as a text format, the file will be created with the appropriate BOM.
+    /// If null, the file is created as an empty binary file.
+    /// </param>
+    /// <returns>
+    /// A new <see cref="TempFile"/> instance representing the created file.
+    /// The caller is responsible for disposing the instance to ensure cleanup.
+    /// </returns>
+    /// <remarks>
+    /// The file is created immediately upon calling this method. If encoding is specified and the extension
+    /// is recognized as a text format, the file will be initialized with the appropriate byte order mark (BOM).
+    /// Otherwise, an empty file is created.
+    /// </remarks>
+    /// <exception cref="IOException">
+    /// Thrown if the file cannot be created (e.g., due to permissions or disk space).
+    /// </exception>
+    /// <example>
+    /// <code>
+    /// // Create empty temp file
+    /// using var temp = TempFile.Create();
+    ///
+    /// // Create temp file with extension
+    /// using var txtFile = TempFile.Create(".txt");
+    ///
+    /// // Create temp file with UTF-8 encoding and BOM
+    /// using var utf8File = TempFile.Create(".txt", Encoding.UTF8);
+    /// </code>
+    /// </example>
     public static TempFile Create(string? extension = null, Encoding? encoding = null)
     {
         var file = new TempFile(extension);
@@ -159,6 +196,56 @@ public static TempFile Create(string? extension = null, Encoding? encoding = nul
         return file;
     }
 
+    /// <summary>
+    /// Creates a new temporary file with the specified text content.
+    /// </summary>
+    /// <param name="content">
+    /// The text content to write to the file.
+    /// </param>
+    /// <param name="extension">
+    /// Optional file extension (e.g., ".txt", ".json", ".xml").
+    /// If not provided, no extension is added.
+    /// The extension should include the leading dot.
+    /// </param>
+    /// <param name="encoding">
+    /// Optional text encoding to use when writing the content.
+    /// If null, the default UTF-8 encoding without BOM is used.
+    /// </param>
+    /// <returns>
+    /// A task that represents the asynchronous operation.
+    /// The task result contains a new <see cref="TempFile"/> instance with the written content.
+    /// The caller is responsible for disposing the instance to ensure cleanup.
+    /// </returns>
+    /// <remarks>
+    /// <para>
+    /// The file is created and written asynchronously. The content is written using the specified
+    /// encoding, or UTF-8 without BOM if no encoding is specified.
+    /// </para>
+    /// <para>
+    /// This method is ideal for creating temporary test data files, configuration files, or
+    /// any text-based content that needs to be written to disk for testing purposes.
+    /// </para>
+    /// </remarks>
+    /// <exception cref="IOException">
+    /// Thrown if the file cannot be created or written to (e.g., due to permissions or disk space).
+    /// </exception>
+    /// <example>
+    /// <code>
+    /// // Create temp file with simple text
+    /// using var temp = await TempFile.CreateText("Hello, World!");
+    ///
+    /// // Create JSON file
+    /// using var json = await TempFile.CreateText(
+    ///     "{\"name\": \"test\"}",
+    ///     ".json");
+    ///
+    /// // Create file with specific encoding
+    /// using var utf8 = await TempFile.CreateText(
+    ///     "Content with special chars: äöü",
+    ///     ".txt",
+    ///     Encoding.UTF8);
+    /// </code>
+    /// </example>
     public static async Task<TempFile> CreateText(string content, string? extension = null, Encoding? encoding = null)
     {
         var file = new TempFile(extension);
@@ -175,6 +262,52 @@ public static async Task<TempFile> CreateText(string content, string? extension
         return file;
     }
 
+    /// <summary>
+    /// Creates a new temporary file with the specified binary content.
+    /// </summary>
+    /// <param name="content">
+    /// The binary content to write to the file.
+    /// Can be empty to create an empty file.
+    /// </param>
+    /// <param name="extension">
+    /// Optional file extension (e.g., ".bin", ".dat", ".png").
+    /// If not provided, no extension is added.
+    /// The extension should include the leading dot.
+    /// </param>
+    /// <returns>
+    /// A task that represents the asynchronous operation.
+    /// The task result contains a new <see cref="TempFile"/> instance with the written content.
+    /// The caller is responsible for disposing the instance to ensure cleanup.
+    /// </returns>
+    /// <remarks>
+    /// <para>
+    /// The file is created and written asynchronously with the exact binary content provided.
+    /// This method is suitable for creating temporary files containing binary data such as
+    /// images, serialized objects, or any non-text data.
+    /// </para>
+    /// <para>
+    /// The content is written as-is without any encoding or transformation.
+    /// </para>
+    /// </remarks>
+    /// <exception cref="IOException">
+    /// Thrown if the file cannot be created or written to (e.g., due to permissions or disk space).
+    /// </exception>
+    /// <example>
+    /// <code>
+    /// // Create temp file with binary data
+    /// byte[] data = [0x01, 0x02, 0x03, 0x04];
+    /// using var temp = await TempFile.CreateBinary(data);
+    ///
+    /// // Create image file
+    /// byte[] imageData = await File.ReadAllBytesAsync("source.png");
+    /// using var image = await TempFile.CreateBinary(imageData, ".png");
+    ///
+    /// // Create empty binary file
+    /// using var empty = await TempFile.CreateBinary(
+    ///     ReadOnlyMemory&lt;byte&gt;.Empty,
+    ///     ".bin");
+    /// </code>
+    /// </example>
     public static async Task<TempFile> CreateBinary(ReadOnlyMemory<byte> content, string? extension = null)
     {
         var file = new TempFile(extension);