Skip to content

Commit 15d0547

Browse files
vbreussvbreuss
authored
feat: add new File methods from .NET 9 (#1193)
- Task AppendAllBytesAsync(string, byte[], CancellationToken) - Task AppendAllBytesAsync(string, ReadOnlyMemory<byte>, CancellationToken) - Task AppendAllTextAsync(string, ReadOnlyMemory<char>, Encoding, CancellationToken) - Task AppendAllTextAsync(string, ReadOnlyMemory<char>, CancellationToken) - Task WriteAllBytesAsync(string, ReadOnlyMemory<byte>, CancellationToken) - Task WriteAllTextAsync(string, ReadOnlyMemory<char>, Encoding, CancellationToken) - Task WriteAllTextAsync(string, ReadOnlyMemory<char>, CancellationToken) - void AppendAllBytes(string, byte[]) - void AppendAllBytes(string, ReadOnlySpan<byte>) - void AppendAllText(string, ReadOnlySpan<char>) - void AppendAllText(string, ReadOnlySpan<char>, Encoding) - void WriteAllBytes(string, ReadOnlySpan<byte>) - void WriteAllText(string, ReadOnlySpan<char>) - void WriteAllText(string, ReadOnlySpan<char>, Encoding)
1 parent 5d1885d commit 15d0547

File tree

11 files changed

+414
-62
lines changed

11 files changed

+414
-62
lines changed

‎Directory.Build.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<DefineConstants Condition="'$(TargetFramework)' == 'net9.0' OR '$(TargetFramework)' == 'net8.0' OR '$(TargetFramework)' == 'net7.0' OR '$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS;FEATURE_ADVANCED_PATH_OPERATIONS;FEATURE_PATH_JOIN_WITH_SPAN;FEATURE_SPAN</DefineConstants>
1515
<DefineConstants Condition="'$(TargetFramework)' == 'net9.0' OR '$(TargetFramework)' == 'net8.0' OR '$(TargetFramework)' == 'net7.0' OR '$(TargetFramework)' == 'net6.0'">$(DefineConstants);FEATURE_FILE_MOVE_WITH_OVERWRITE;FEATURE_SUPPORTED_OS_ATTRIBUTE;FEATURE_FILE_SYSTEM_WATCHER_FILTERS;FEATURE_ENDS_IN_DIRECTORY_SEPARATOR;FEATURE_PATH_JOIN_WITH_PARAMS;FEATURE_PATH_JOIN_WITH_FOUR_PATHS;FEATURE_FILE_SYSTEM_INFO_LINK_TARGET;FEATURE_CREATE_SYMBOLIC_LINK;FEATURE_FILESTREAM_OPTIONS</DefineConstants>
1616
<DefineConstants Condition="'$(TargetFramework)' == 'net9.0' OR '$(TargetFramework)' == 'net8.0' OR '$(TargetFramework)' == 'net7.0'">$(DefineConstants);FEATURE_PATH_EXISTS;FEATURE_FILE_SYSTEM_WATCHER_WAIT_WITH_TIMESPAN;FEATURE_FILE_ATTRIBUTES_VIA_HANDLE;FEATURE_CREATE_TEMP_SUBDIRECTORY;FEATURE_READ_LINES_ASYNC;FEATURE_UNIX_FILE_MODE</DefineConstants>
17-
<DefineConstants Condition="'$(TargetFramework)' == 'net9.0'">$(DefineConstants);FEATURE_PATH_SPAN</DefineConstants>
17+
<DefineConstants Condition="'$(TargetFramework)' == 'net9.0'">$(DefineConstants);FEATURE_PATH_SPAN;FEATURE_FILE_SPAN</DefineConstants>
1818
<DefineConstants>$(DefineConstants);FEATURE_SERIALIZABLE</DefineConstants>
1919
</PropertyGroup>
2020
<ItemGroup>

‎src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFile.Async.cs‎

Lines changed: 67 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,57 +10,87 @@ namespace System.IO.Abstractions.TestingHelpers
1010
{
1111
partial class MockFile
1212
{
13+
#if FEATURE_FILE_SPAN
14+
/// <inheritdoc cref="IFile.AppendAllBytesAsync(string,byte[],CancellationToken)"/>
15+
public override Task AppendAllBytesAsync(string path, byte[] bytes, CancellationToken cancellationToken = default)
16+
{
17+
cancellationToken.ThrowIfCancellationRequested();
18+
AppendAllBytes(path, bytes);
19+
return Task.CompletedTask;
20+
}
21+
22+
/// <inheritdoc cref="IFile.AppendAllBytesAsync(string,ReadOnlyMemory{byte},CancellationToken)"/>
23+
public override Task AppendAllBytesAsync(string path, ReadOnlyMemory<byte> bytes, CancellationToken cancellationToken = default)
24+
{
25+
return AppendAllBytesAsync(path, bytes.ToArray(), cancellationToken);
26+
}
27+
#endif
1328
/// <inheritdoc />
14-
public override Task AppendAllLinesAsync(string path, IEnumerable<string> contents, CancellationToken cancellationToken = default(CancellationToken)) =>
29+
public override Task AppendAllLinesAsync(string path, IEnumerable<string> contents, CancellationToken cancellationToken = default) =>
1530
AppendAllLinesAsync(path, contents, MockFileData.DefaultEncoding, cancellationToken);
1631

1732
/// <inheritdoc />
18-
public override Task AppendAllLinesAsync(string path, IEnumerable<string> contents, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))
33+
public override Task AppendAllLinesAsync(string path, IEnumerable<string> contents, Encoding encoding, CancellationToken cancellationToken = default)
1934
{
2035
cancellationToken.ThrowIfCancellationRequested();
2136
AppendAllLines(path, contents, encoding);
2237
return Task.CompletedTask;
2338
}
2439

2540
/// <inheritdoc />
26-
public override Task AppendAllTextAsync(string path, string contents, CancellationToken cancellationToken = default(CancellationToken)) =>
41+
public override Task AppendAllTextAsync(string path, string contents, CancellationToken cancellationToken = default) =>
2742
AppendAllTextAsync(path, contents, MockFileData.DefaultEncoding, cancellationToken);
2843

2944

3045
/// <inheritdoc />
31-
public override Task AppendAllTextAsync(string path, string contents, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))
46+
public override Task AppendAllTextAsync(string path, string contents, Encoding encoding, CancellationToken cancellationToken = default)
3247
{
3348
cancellationToken.ThrowIfCancellationRequested();
3449
AppendAllText(path, contents, encoding);
3550
return Task.CompletedTask;
3651
}
52+
53+
#if FEATURE_FILE_SPAN
54+
/// <inheritdoc cref="IFile.AppendAllTextAsync(string,ReadOnlyMemory{char},CancellationToken)"/>
55+
public override Task AppendAllTextAsync(string path, ReadOnlyMemory<char> contents, CancellationToken cancellationToken = default)
56+
{
57+
return AppendAllTextAsync(path, contents.ToString(), cancellationToken);
58+
}
59+
60+
/// <inheritdoc cref="IFile.AppendAllTextAsync(string,ReadOnlyMemory{char},Encoding,CancellationToken)"/>
61+
public override Task AppendAllTextAsync(string path, ReadOnlyMemory<char> contents, Encoding encoding,
62+
CancellationToken cancellationToken = default)
63+
{
64+
return AppendAllTextAsync(path, contents.ToString(), encoding, cancellationToken);
65+
}
66+
#endif
3767

3868
/// <inheritdoc />
39-
public override Task<byte[]> ReadAllBytesAsync(string path, CancellationToken cancellationToken = default(CancellationToken))
69+
public override Task<byte[]> ReadAllBytesAsync(string path, CancellationToken cancellationToken = default)
4070
{
4171
cancellationToken.ThrowIfCancellationRequested();
4272
return Task.FromResult(ReadAllBytes(path));
4373
}
4474

4575
/// <inheritdoc />
46-
public override Task<string[]> ReadAllLinesAsync(string path, CancellationToken cancellationToken = default(CancellationToken)) =>
76+
public override Task<string[]> ReadAllLinesAsync(string path, CancellationToken cancellationToken = default) =>
4777
ReadAllLinesAsync(path, MockFileData.DefaultEncoding, cancellationToken);
4878

4979
/// <inheritdoc />
5080

51-
public override Task<string[]> ReadAllLinesAsync(string path, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))
81+
public override Task<string[]> ReadAllLinesAsync(string path, Encoding encoding, CancellationToken cancellationToken = default)
5282
{
5383
cancellationToken.ThrowIfCancellationRequested();
5484
return Task.FromResult(ReadAllLines(path, encoding));
5585
}
5686

5787
/// <inheritdoc />
58-
public override Task<string> ReadAllTextAsync(string path, CancellationToken cancellationToken) =>
88+
public override Task<string> ReadAllTextAsync(string path, CancellationToken cancellationToken = default) =>
5989
ReadAllTextAsync(path, MockFileData.DefaultEncoding, cancellationToken);
6090

6191

6292
/// <inheritdoc />
63-
public override Task<string> ReadAllTextAsync(string path, Encoding encoding, CancellationToken cancellationToken)
93+
public override Task<string> ReadAllTextAsync(string path, Encoding encoding, CancellationToken cancellationToken = default)
6494
{
6595
cancellationToken.ThrowIfCancellationRequested();
6696
return Task.FromResult(ReadAllText(path, encoding));
@@ -82,36 +112,59 @@ public override async IAsyncEnumerable<string> ReadLinesAsync(string path, Encod
82112
#endif
83113

84114
/// <inheritdoc />
85-
public override Task WriteAllBytesAsync(string path, byte[] bytes, CancellationToken cancellationToken)
115+
public override Task WriteAllBytesAsync(string path, byte[] bytes, CancellationToken cancellationToken = default)
86116
{
87117
cancellationToken.ThrowIfCancellationRequested();
88118
WriteAllBytes(path, bytes);
89119
return Task.CompletedTask;
90120
}
121+
122+
#if FEATURE_FILE_SPAN
123+
/// <inheritdoc cref="IFile.WriteAllBytesAsync(string,ReadOnlyMemory{byte},CancellationToken)"/>
124+
public override Task WriteAllBytesAsync(string path, ReadOnlyMemory<byte> bytes, CancellationToken cancellationToken = default)
125+
{
126+
return WriteAllBytesAsync(path, bytes.ToArray(), cancellationToken);
127+
}
128+
#endif
91129

92130
/// <inheritdoc />
93-
public override Task WriteAllLinesAsync(string path, IEnumerable<string> contents, CancellationToken cancellationToken) =>
131+
public override Task WriteAllLinesAsync(string path, IEnumerable<string> contents, CancellationToken cancellationToken = default) =>
94132
WriteAllLinesAsync(path, contents, MockFileData.DefaultEncoding, cancellationToken);
95133

96134
/// <inheritdoc />
97-
public override Task WriteAllLinesAsync(string path, IEnumerable<string> contents, Encoding encoding, CancellationToken cancellationToken)
135+
public override Task WriteAllLinesAsync(string path, IEnumerable<string> contents, Encoding encoding, CancellationToken cancellationToken = default)
98136
{
99137
cancellationToken.ThrowIfCancellationRequested();
100138
WriteAllLines(path, contents, encoding);
101139
return Task.CompletedTask;
102140
}
103141

104142
/// <inheritdoc />
105-
public override Task WriteAllTextAsync(string path, string contents, CancellationToken cancellationToken) =>
143+
public override Task WriteAllTextAsync(string path, string contents, CancellationToken cancellationToken = default) =>
106144
WriteAllTextAsync(path, contents, MockFileData.DefaultEncoding, cancellationToken);
107145

108146
/// <inheritdoc />
109-
public override Task WriteAllTextAsync(string path, string contents, Encoding encoding, CancellationToken cancellationToken)
147+
public override Task WriteAllTextAsync(string path, string contents, Encoding encoding, CancellationToken cancellationToken = default)
110148
{
111149
cancellationToken.ThrowIfCancellationRequested();
112150
WriteAllText(path, contents, encoding);
113151
return Task.CompletedTask;
114152
}
153+
154+
#if FEATURE_FILE_SPAN
155+
/// <inheritdoc cref="IFile.WriteAllTextAsync(string,ReadOnlyMemory{char},CancellationToken)"/>
156+
public override Task WriteAllTextAsync(string path, ReadOnlyMemory<char> contents, CancellationToken cancellationToken = default)
157+
{
158+
return WriteAllTextAsync(path, contents.ToString(), cancellationToken);
159+
}
160+
161+
/// <inheritdoc cref="IFile.WriteAllTextAsync(string,ReadOnlyMemory{char},Encoding,CancellationToken)"/>
162+
public override Task WriteAllTextAsync(string path, ReadOnlyMemory<char> contents, Encoding encoding,
163+
CancellationToken cancellationToken = default)
164+
{
165+
return WriteAllTextAsync(path, contents.ToString(), encoding, cancellationToken);
166+
}
167+
#endif
115168
}
116169
}
117170

‎src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFile.cs‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,33 @@ public MockFile(IMockFileDataAccessor mockFileDataAccessor) : base(mockFileDataA
2222
this.mockFileDataAccessor = mockFileDataAccessor ?? throw new ArgumentNullException(nameof(mockFileDataAccessor));
2323
}
2424

25+
#if FEATURE_FILE_SPAN
26+
/// <inheritdoc cref="IFile.AppendAllBytes(string,byte[])"/>
27+
public override void AppendAllBytes(string path, byte[] bytes)
28+
{
29+
mockFileDataAccessor.PathVerifier.IsLegalAbsoluteOrRelative(path, "path");
30+
31+
if (!mockFileDataAccessor.FileExists(path))
32+
{
33+
VerifyDirectoryExists(path);
34+
mockFileDataAccessor.AddFile(path, mockFileDataAccessor.AdjustTimes(new MockFileData(bytes), TimeAdjustments.All));
35+
}
36+
else
37+
{
38+
var file = mockFileDataAccessor.GetFile(path);
39+
file.CheckFileAccess(path, FileAccess.Write);
40+
mockFileDataAccessor.AdjustTimes(file, TimeAdjustments.LastAccessTime | TimeAdjustments.LastWriteTime);
41+
file.Contents = file.Contents.Concat(bytes).ToArray();
42+
}
43+
}
44+
45+
/// <inheritdoc cref="IFile.AppendAllBytes(string,ReadOnlySpan{byte})"/>
46+
public override void AppendAllBytes(string path, ReadOnlySpan<byte> bytes)
47+
{
48+
AppendAllBytes(path, bytes.ToArray());
49+
}
50+
#endif
51+
2552
/// <inheritdoc />
2653
public override void AppendAllLines(string path, IEnumerable<string> contents)
2754
{
@@ -70,6 +97,20 @@ public override void AppendAllText(string path, string contents, Encoding encodi
7097
}
7198
}
7299

100+
#if FEATURE_FILE_SPAN
101+
/// <inheritdoc cref="IFile.AppendAllText(string,ReadOnlySpan{char})"/>
102+
public override void AppendAllText(string path, ReadOnlySpan<char> contents)
103+
{
104+
AppendAllText(path, contents.ToString());
105+
}
106+
107+
/// <inheritdoc cref="IFile.AppendAllText(string,ReadOnlySpan{char},Encoding)"/>
108+
public override void AppendAllText(string path, ReadOnlySpan<char> contents, Encoding encoding)
109+
{
110+
AppendAllText(path, contents.ToString(), encoding);
111+
}
112+
#endif
113+
73114
/// <inheritdoc />
74115
public override StreamWriter AppendText(string path)
75116
{
@@ -1025,6 +1066,14 @@ public override void WriteAllBytes(string path, byte[] bytes)
10251066

10261067
mockFileDataAccessor.AddFile(path, mockFileDataAccessor.AdjustTimes(new MockFileData(bytes.ToArray()), TimeAdjustments.All));
10271068
}
1069+
1070+
#if FEATURE_FILE_SPAN
1071+
/// <inheritdoc cref="IFile.WriteAllBytes(string,ReadOnlySpan{byte})"/>
1072+
public override void WriteAllBytes(string path, ReadOnlySpan<byte> bytes)
1073+
{
1074+
WriteAllBytes(path, bytes.ToArray());
1075+
}
1076+
#endif
10281077

10291078
/// <summary>
10301079
/// Creates a new file, writes a collection of strings to the file, and then closes the file.
@@ -1296,6 +1345,20 @@ public override void WriteAllText(string path, string contents, Encoding encodin
12961345
mockFileDataAccessor.AddFile(path, mockFileDataAccessor.AdjustTimes(data, TimeAdjustments.All));
12971346
}
12981347

1348+
#if FEATURE_FILE_SPAN
1349+
/// <inheritdoc cref="IFile.WriteAllText(string,ReadOnlySpan{char})"/>
1350+
public override void WriteAllText(string path, ReadOnlySpan<char> contents)
1351+
{
1352+
WriteAllText(path, contents.ToString());
1353+
}
1354+
1355+
/// <inheritdoc cref="IFile.WriteAllText(string,ReadOnlySpan{char},Encoding)"/>
1356+
public override void WriteAllText(string path, ReadOnlySpan<char> contents, Encoding encoding)
1357+
{
1358+
WriteAllText(path, contents.ToString(), encoding);
1359+
}
1360+
#endif
1361+
12991362
internal static string ReadAllBytes(byte[] contents, Encoding encoding)
13001363
{
13011364
using (var ms = new MemoryStream(contents))

0 commit comments

Comments
 (0)