StreamWriter does use TextWriter.NewLine for newlines rendering overriding get only useless
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with the TextWriter.NewLine property and StreamWriter.WriteLine behavior, then reproduce the supplied SmileyStreamWriter example on the current runtime. The work is done when an overridden NewLine getter affects the newline emitted by WriteLine, with regression coverage for the behavior.
Written by the indexing model from the issue text.
Description
Description
When override get property TextWriter.NewLine, it does not affect the newline being used as a set on the property is required in order to set the backing field that is actually used. This is quite unintuitive as one would expect the overloaded get NewLine to be used, otherwise what is the point of it being overridable anyways?
Reproduction Steps
public sealed class SmileyStreamWriter(Stream stream, IFormatProvider formatProvider, bool leaveOpen)
: StreamWriter(stream, System.Text.Encoding.UTF8, -1, leaveOpen)
{
public override string NewLine => ":)";
public override IFormatProvider FormatProvider { get; } = formatProvider;
}
using var file = File.Open("test.txt", FileMode.CreateNew);
var sw = new SmileyStreamWriter(file, CultureInfo.InvariantCulture, leaveOpen: true)
sw.WriteLine("test"); // Writes test\r\n (or \n on unix).
Expected behavior
Expect to use the get override of newline.
Actual behavior
Uses platform default.
Regression?
No idea.
Known Workarounds
Use explicit NewLine set in constructor of derived class rendering overriding pointless.
Configuration
No response
Other information
No response
- Dominant language
- C#
- Stars
- 18.3k
- Forks
- 5.6k
- PR merge metrics
- PR metrics pending
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/runtime
-
agentic-workflows untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
area-System.Reflection blocking-clean-ci-optional Known Build Error os-mac-os-x untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
area-CodeGen-coreclr untriaged
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
agentic-workflows untriaged
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
area-VM-meta-mono untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·
-
area/docs-content Bug pulumi/docs
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
Create parent directories only after the containment check in InstallHelper.TryExtractToDirectory Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSResourceGet#2056 ·