[API Proposal]: Add IPAddress, IPEndPoint, DnsEndPoint, PhysicalAddress json built-in converters

[DrkWzrd]

Background and motivation

Sorry for my english.

#83201 should coming with another convenience implementations, like mentioned in issue title.

API Proposal

Something like this:

class IPAddressConverter : JsonConverter<IPAddress>
{
	public override IPAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
	{
		var token = reader.GetString();
		return token is null ? null : IPAddress.Parse(token);
	}

	public override void Write(Utf8JsonWriter writer, IPAddress value, JsonSerializerOptions options)
	{
		writer.WriteStringValue(value.ToString());
	}
}

class PhysicalAddressConverter : JsonConverter<PhysicalAddress>
{

	public override PhysicalAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
	{
		var token = reader.GetString();
		return token is null ? null : PhysicalAddress.Parse(token);
	}

	public override void Write(Utf8JsonWriter writer, PhysicalAddress value, JsonSerializerOptions options)
	{
		writer.WriteStringValue(value.ToString());
	}
}

API Usage

var ip = new IPAddress("192.168.1.1");
var json = JsonSerializer.Serialize(ip);

Alternative Designs

No response

Risks

I can't think any.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-text-json, @gregsdennis
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and motivation

Sorry for my english.

#83201 should coming with another convenience implementations, like mentioned in issue title.

API Proposal

Something like this:

class IPAddressConverter : JsonConverter<IPAddress>
{
	public override IPAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
	{
		var token = reader.GetString();
		return token is null ? null : IPAddress.Parse(token);
	}

	public override void Write(Utf8JsonWriter writer, IPAddress value, JsonSerializerOptions options)
	{
		writer.WriteStringValue(value.ToString());
	}
}

class PhysicalAddressConverter : JsonConverter<PhysicalAddress>
{

	public override PhysicalAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
	{
		var token = reader.GetString();
		return token is null ? null : PhysicalAddress.Parse(token);
	}

	public override void Write(Utf8JsonWriter writer, PhysicalAddress value, JsonSerializerOptions options)
	{
		writer.WriteStringValue(value.ToString());
	}
}

API Usage

var ip = new IPAddress("192.168.1.1");
var json = JsonSerializer.Serialize(ip);

Alternative Designs

No response

Risks

I can't think any.

Author:	DrkWzrd
Assignees:	-
Labels:	api-suggestion, area-System.Text.Json
Milestone:	-

[eiriktsarpalis]

It's not something we could support out of the box, since STJ can't take a dependency on networking components. As usual the recommendation would be to author custom converters for the types that you need to serialize.

[gregsdennis]

Once you've coded the converters, it'd make a great Nuget package. In fact, I'd be surprised if there's not already one out there.