Repository navigation
[API Proposal]: Add ReadOnlySequence overload for WriteRawValue #68223
Description
Background and motivation
When using the Utf8JsonWriter.WriteRawValue API, you can't pass multiple segments in to write a single value, you have to allocate a contiguous array and do a single call to WriteRawValue. In our use case we already have a ReadOnlySequence<byte> and want to write it as a raw json value.
But because the API only accepts string or span, we need to write the following:
if (result.RawSerializedData.IsSingleSegment)
{
writer.WriteRawValue(result.RawSerializedData.First.Span, skipInputValidation: true);
}
else
{
writer.WriteRawValue(result.RawSerializedData.ToArray(), skipInputValidation: true);
}API Proposal
namespace System.Text.Json
{
public sealed partial class Utf8JsonWriter
{
+ public void WriteRawValue(ReadOnlySequence<byte> json, bool skipInputValidation = false);
+ public void WriteRawValue(ReadOnlySequence<char> json, bool skipInputValidation = false);
}
}API Usage
void MyFunc(Utf8JsonWriter writer, ReadOnlySequence<byte> sequence)
{
writer.WriteRawValue(sequence);
}Alternative Designs
No response
Risks
No response
Activity
teo-tsirpanis commentedon Apr 19, 2022
There isn't an implicit conversion from a string to a
ReadOnlySequence<char>so the[StringSyntax(StringSyntaxAttribute.Json)]is not needed. And you forgot an issue title. 😅BrennanConroy commentedon Apr 19, 2022
Haha, I was too focused on filling out the API template!
[-][API Proposal]: [/-][+][API Proposal]: Add ReadOnlySequence overload for WriteRawValue[/+]krwq commentedon Jun 7, 2022
Suggestion looks good to me as proposed, although we unlikely will have time to do it in this release, marking as 8.0.0 so it's on our radar for vNext.
terrajobst commentedon Aug 16, 2022
Video
ReadOnlySequence<char>because we'd have to deal with transcoding surrogate pairs across elements in the sequence, which is quite a bit of work that nobody seems to be asking for right now.lateapexearlyspeed commentedon Sep 30, 2022
Hi, I would try to add this API by this PR, could you please review?
Also, I modified parameter name from
jsontoutf8Jsonbecause it is for byte version rather than char (string), which seems being followed by existing overloads.Correct me, thanks !
eiriktsarpalis commentedon Sep 30, 2022
Change sounds reasonable to me, thanks for correcting it.