Skip to content

Rename XML model serialization helper method from Write to WriteXml #9750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jorgerangel-msft merged 3 commits into from
Feb 20, 2026
Merged

Rename XML model serialization helper method from Write to WriteXml #9750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3acb7b
Initial plan
Copilot Feb 19, 2026
7ce0600
Rename XML Write method to WriteXml to avoid collision with model pro…
Copilot Feb 19, 2026
dfee7bb
Restore IPersistableModel<T>.Write in test data files; only rename pr…
Copilot Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...rosoft.TypeSpec.Generator.ClientModel/src/Providers/MrwSerializationTypeDefinition.Xml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Microsoft.TypeSpec.Generator.ClientModel.Providers
{
public partial class MrwSerializationTypeDefinition
{
private const string XmlWriteMethodName = "Write";
private const string XmlWriteMethodName = "WriteXml";
private const string XmlModelWriteCoreMethodName = "XmlModelWriteCore";
private readonly ParameterProvider _xmlWriterParameter = new("writer", $"The XML writer.", typeof(XmlWriter));
private readonly ParameterProvider _xElementDeserializationParam = new("element", $"The xml element to deserialize.", typeof(XElement));
Expand Down Expand Up @@ -121,7 +121,7 @@ private MethodBodyStatement[] BuildXmlModelWriteCoreMethodBody()

private MethodProvider BuildXmlWriteMethod()
{
// private void Write(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
// private void WriteXml(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
return new MethodProvider(
new MethodSignature(XmlWriteMethodName, null, MethodSignatureModifiers.Private, null, null, [_xmlWriterParameter, _serializationOptionsParameter, _nameHintParameter]),
BuildXmlWriteMethodBody(),
Expand Down
4 changes: 2 additions & 2 deletions ...efinitions/TestData/XmlSerializationCustomizationTests/CanReplaceDeserializationMethod.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public partial class MockInputModel : global::System.ClientModel.Primitives.IPer
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "MockInputModel");
this.WriteXml(writer, options, "MockInputModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -60,7 +60,7 @@ public partial class MockInputModel : global::System.ClientModel.Primitives.IPer

string global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.MockInputModel>.GetFormatFromOptions(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => "X";

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
2 changes: 1 addition & 1 deletion ...tions/TestData/XmlSerializationTests/PersistableModelWriteCoreHandlesJsonAndXmlFormats.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public partial class TestModel
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestModel");
this.WriteXml(writer, options, "TestModel");
}
if ((stream.Position > int.MaxValue))
{
Expand Down
2 changes: 1 addition & 1 deletion ...peDefinitions/TestData/XmlSerializationTests/PersistableModelWriteCoreHandlesXmlFormat.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public partial class TestXmlModel
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand Down
2 changes: 1 addition & 1 deletion ...ypeDefinitions/TestData/XmlSerializationTests/XmlSerializationForDiscriminatedBaseType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public partial class Pet
{
global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.Pet>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
2 changes: 1 addition & 1 deletion ...TypeDefinitions/TestData/XmlSerializationTests/XmlSerializationForDiscriminatedSubtype.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public partial class Cat
{
global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.Cat>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
2 changes: 1 addition & 1 deletion ...eDefinitions/TestData/XmlSerializationTests/XmlSerializationHandlesAttributeProperties.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public partial class TestXmlModel
{
global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
2 changes: 1 addition & 1 deletion ...finitions/TestData/XmlSerializationTests/XmlSerializationHandlesAttributeWithNamespace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public partial class TestXmlModel
{
global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
2 changes: 1 addition & 1 deletion ...Definitions/TestData/XmlSerializationTests/XmlSerializationHandlesElementWithNamespace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public partial class TestXmlModel
{
global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...s/TestData/XmlSerializationTests/XmlSerializationHandlesNullableDateTimeOffsetProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public partial class TestXmlModel : global::System.ClientModel.Primitives.IPersi
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -40,7 +40,7 @@ public partial class TestXmlModel : global::System.ClientModel.Primitives.IPersi

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...nitions/TestData/XmlSerializationTests/XmlSerializationHandlesNullableTimeSpanProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public partial class TestXmlModel : global::System.ClientModel.Primitives.IPersi
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -40,7 +40,7 @@ public partial class TestXmlModel : global::System.ClientModel.Primitives.IPersi

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...TestData/XmlSerializationTests/XmlSerializationMethodBodyContainsPropertySerialization.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ internal TestXmlModel()
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -44,7 +44,7 @@ internal TestXmlModel()

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...ypeDefinitions/TestData/XmlSerializationTests/XmlSerializationMethodHandlesNestedModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public partial class OuterModel : global::System.ClientModel.Primitives.IPersist
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "OuterModel");
this.WriteXml(writer, options, "OuterModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -40,7 +40,7 @@ public partial class OuterModel : global::System.ClientModel.Primitives.IPersist

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.OuterModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...ions/TestData/XmlSerializationTests/XmlSerializationMethodHandlesUnwrappedListProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ internal TestXmlModel()
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -44,7 +44,7 @@ internal TestXmlModel()

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
4 changes: 2 additions & 2 deletions ...itions/TestData/XmlSerializationTests/XmlSerializationMethodHandlesWrappedListProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ internal TestXmlModel()
{
using (global::System.Xml.XmlWriter writer = global::System.Xml.XmlWriter.Create(stream, global::Sample.ModelSerializationExtensions.XmlWriterSettings))
{
this.Write(writer, options, "TestXmlModel");
this.WriteXml(writer, options, "TestXmlModel");
}
if ((stream.Position > int.MaxValue))
{
Expand All @@ -44,7 +44,7 @@ internal TestXmlModel()

global::System.BinaryData global::System.ClientModel.Primitives.IPersistableModel<global::Sample.Models.TestXmlModel>.Write(global::System.ClientModel.Primitives.ModelReaderWriterOptions options) => this.PersistableModelWriteCore(options);

private void Write(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
private void WriteXml(global::System.Xml.XmlWriter writer, global::System.ClientModel.Primitives.ModelReaderWriterOptions options, string nameHint)
{
if ((nameHint != null))
{
Expand Down
12 changes: 6 additions & 6 deletions ...rator.ClientModel/test/Providers/MrwSerializationTypeDefinitions/XmlSerializationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ public async Task XmlSerializationForDiscriminatedBaseType()

var writer = new TypeProviderWriter(new FilteredMethodsTypeProvider(
mrwProvider!,
name => name == "XmlModelWriteCore" || name == "Write"));
name => name == "XmlModelWriteCore" || name == "WriteXml" || name == "Write"));

var file = writer.Write();
Assert.AreEqual(Helpers.GetExpectedFromFile(), file.Content);
Expand Down Expand Up @@ -552,7 +552,7 @@ public async Task XmlSerializationForDiscriminatedSubtype()

var writer = new TypeProviderWriter(new FilteredMethodsTypeProvider(
mrwProvider!,
name => name == "XmlModelWriteCore" || name == "Write"));
name => name == "XmlModelWriteCore" || name == "WriteXml" || name == "Write"));

var file = writer.Write();
Assert.AreEqual(Helpers.GetExpectedFromFile(), file.Content);
Expand All @@ -578,7 +578,7 @@ public async Task XmlSerializationHandlesAttributeProperties()

var writer = new TypeProviderWriter(new FilteredMethodsTypeProvider(
serializationProvider,
name => name == "XmlModelWriteCore" || name == "Write"));
name => name == "XmlModelWriteCore" || name == "WriteXml" || name == "Write"));

var file = writer.Write();
Assert.AreEqual(Helpers.GetExpectedFromFile(), file.Content);
Expand All @@ -605,7 +605,7 @@ public async Task XmlSerializationHandlesAttributeWithNamespace()

var writer = new TypeProviderWriter(new FilteredMethodsTypeProvider(
serializationProvider,
name => name == "XmlModelWriteCore" || name == "Write"));
name => name == "XmlModelWriteCore" || name == "WriteXml" || name == "Write"));

var file = writer.Write();
Assert.AreEqual(Helpers.GetExpectedFromFile(), file.Content);
Expand All @@ -631,7 +631,7 @@ public async Task XmlSerializationHandlesElementWithNamespace()

var writer = new TypeProviderWriter(new FilteredMethodsTypeProvider(
serializationProvider,
name => name == "XmlModelWriteCore" || name == "Write"));
name => name == "XmlModelWriteCore" || name == "WriteXml" || name == "Write"));

var file = writer.Write();
Assert.AreEqual(Helpers.GetExpectedFromFile(), file.Content);
Expand Down Expand Up @@ -699,7 +699,7 @@ protected override MethodProvider[] BuildMethods()
return [.. base.BuildMethods()
.Where(m => m.Signature.Name.StartsWith("XmlModelWriteCore") ||
m.Signature.Name.StartsWith("PersistableModelWriteCore") ||
m.Signature.Name == "Write")];
m.Signature.Name == "WriteXml" || m.Signature.Name == "Write")];
}

protected override FieldProvider[] BuildFields() => [];
Expand Down
4 changes: 2 additions & 2 deletions .../generator/TestProjects/Local/Sample-TypeSpec/src/Generated/Models/Plant.Serialization.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions
{
using (XmlWriter writer = XmlWriter.Create(stream, ModelSerializationExtensions.XmlWriterSettings))
{
Write(writer, options, "Plant");
WriteXml(writer, options, "Plant");
}
if (stream.Position > int.MaxValue)
{
Expand Down Expand Up @@ -167,7 +167,7 @@ internal static Plant DeserializePlant(JsonElement element, ModelReaderWriterOpt
/// <param name="writer"> The XML writer. </param>
/// <param name="options"> The client options for reading and writing models. </param>
/// <param name="nameHint"> An optional name hint. </param>
private void Write(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
private void WriteXml(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
{
if (nameHint != null)
{
Expand Down
4 changes: 2 additions & 2 deletions ...p/generator/TestProjects/Local/Sample-TypeSpec/src/Generated/Models/Tree.Serialization.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions
{
using (XmlWriter writer = XmlWriter.Create(stream, ModelSerializationExtensions.XmlWriterSettings))
{
Write(writer, options, "Tree");
WriteXml(writer, options, "Tree");
}
if (stream.Position > int.MaxValue)
{
Expand Down Expand Up @@ -209,7 +209,7 @@ internal static Tree DeserializeTree(JsonElement element, ModelReaderWriterOptio
/// <param name="writer"> The XML writer. </param>
/// <param name="options"> The client options for reading and writing models. </param>
/// <param name="nameHint"> An optional name hint. </param>
private void Write(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
private void WriteXml(XmlWriter writer, ModelReaderWriterOptions options, string nameHint)
{
if (nameHint != null)
{
Expand Down
Loading
Loading