Skip to content

Commit 7623f8e

Browse files
authored
Remove SepReader.Col.ToStringRaw from public API (#65)
With unescape "Raw" becomes confusing as users may think this means no unescaping while it's intend was to mean unpooled, it has therefore been made internal and renamed to `ToStringDirect`.
1 parent 6af3eb2 commit 7623f8e

File tree

8 files changed

+15
-9
lines changed

8 files changed

+15
-9
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1258,7 +1258,6 @@ namespace nietras.SeparatedValues
12581258
public T Parse<T>()
12591259
where T : System.ISpanParsable<T> { }
12601260
public override string ToString() { }
1261-
public string ToStringRaw() { }
12621261
public T? TryParse<T>()
12631262
where T : struct, System.ISpanParsable<T> { }
12641263
public bool TryParse<T>(out T value)

src/Sep.Test/SepReaderColTest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public void SepReaderColTest_ToString()
4040
}
4141

4242
[TestMethod]
43-
public void SepReaderColTest_ToStringRaw()
43+
public void SepReaderColTest_ToStringDirect()
4444
{
45-
Run(col => Assert.AreEqual(ColText, col.ToStringRaw()));
45+
Run(col => Assert.AreEqual(ColText, col.ToStringDirect()));
4646
Run(col => Assert.AreSame(string.Empty, col.ToString()), "");
4747
}
4848

src/Sep.Test/SepReaderColsTest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ public unsafe void SepReaderColsTest_Select_MethodPointer_ToString()
172172
}
173173

174174
[TestMethod]
175-
public void SepReaderColsTest_Select_ToStringRaw()
175+
public void SepReaderColsTest_Select_ToStringDirect()
176176
{
177-
Run((cols, range) => CollectionAssert.AreEqual(_colTexts[range], cols.Select(c => c.ToStringRaw()).ToArray()));
177+
Run((cols, range) => CollectionAssert.AreEqual(_colTexts[range], cols.Select(c => c.ToStringDirect()).ToArray()));
178178
}
179179

180180
static string ToString(SepReader.Col col) => col.ToString();

src/Sep/CompatibilitySuppressions.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/diagnostic-ids -->
33
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
4+
<Suppression>
5+
<DiagnosticId>CP0002</DiagnosticId>
6+
<Target>M:nietras.SeparatedValues.SepReader.Col.ToStringRaw</Target>
7+
<Left>lib/net7.0/Sep.dll</Left>
8+
<Right>lib/net7.0/Sep.dll</Right>
9+
<IsBaselineSuppression>true</IsBaselineSuppression>
10+
</Suppression>
411
<Suppression>
512
<DiagnosticId>CP0002</DiagnosticId>
613
<Target>M:nietras.SeparatedValues.SepReader.Cols.get_Length</Target>

src/Sep/SepReader.Col.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ internal Col(SepReaderState state, int colIndex)
2626

2727
// Allow opt out of pooling and don't add yet another configuration option
2828
[MethodImpl(MethodImplOptions.AggressiveInlining)]
29-
public string ToStringRaw() => _state.ToStringRaw(_colIndex);
29+
internal string ToStringDirect() => _state.ToStringDirect(_colIndex);
3030

3131
[MethodImpl(MethodImplOptions.AggressiveInlining)]
3232
public T Parse<T>() where T : ISpanParsable<T> => _state.Parse<T>(_colIndex);

src/Sep/SepReader.Row.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ ColDebugView[] GetCols()
200200
var maybeHeader = _state._hasHeader ? _state._header : null;
201201
for (var colIndex = 0; colIndex < cols.Length; colIndex++)
202202
{
203-
var colValue = row[colIndex].ToStringRaw();
203+
var colValue = row[colIndex].ToStringDirect();
204204
cols[colIndex] = new(colIndex, maybeHeader?.ColNames[colIndex], colValue);
205205
}
206206
return cols;

src/Sep/SepReader.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ internal void Initialize(SepReaderOptions options)
113113
var colNameToIndex = new Dictionary<string, int>(_colCount);
114114
for (var colIndex = 0; colIndex < _colCount; colIndex++)
115115
{
116-
var colName = ToStringRaw(colIndex);
116+
var colName = ToStringDirect(colIndex);
117117
colNameToIndex.Add(colName, colIndex);
118118
}
119119
var headerRow = new string(RowSpan());

src/Sep/SepReaderState.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ internal string ToStringDefault(int index)
169169
return _toString.ToString(span, index);
170170
}
171171

172-
internal string ToStringRaw(int index)
172+
internal string ToStringDirect(int index)
173173
{
174174
var span = GetColSpan(index);
175175
var s = TryGetStaticallyCachedString(span);

0 commit comments

Comments
 (0)