with 式 - 非破壊的変更によってプロパティが変更された新しいオブジェクトを作成する

  • [アーティクル]

with 式では、指定したプロパティとフィールドが変更されたオペランドのコピーが作成されます。 変更するメンバーとその新しい値は、オブジェクト初期化子構文を使用して指定します。

using System;

public class WithExpressionBasicExample
{
    public record NamedPoint(string Name, int X, int Y);

    public static void Main()
    {
        var p1 = new NamedPoint("A", 0, 0);
        Console.WriteLine($"{nameof(p1)}: {p1}");  // output: p1: NamedPoint { Name = A, X = 0, Y = 0 }
        
        var p2 = p1 with { Name = "B", X = 5 };
        Console.WriteLine($"{nameof(p2)}: {p2}");  // output: p2: NamedPoint { Name = B, X = 5, Y = 0 }
        
        var p3 = p1 with 
            { 
                Name = "C", 
                Y = 4 
            };
        Console.WriteLine($"{nameof(p3)}: {p3}");  // output: p3: NamedPoint { Name = C, X = 0, Y = 4 }

        Console.WriteLine($"{nameof(p1)}: {p1}");  // output: p1: NamedPoint { Name = A, X = 0, Y = 0 }

        var apples = new { Item = "Apples", Price = 1.19m };
        Console.WriteLine($"Original: {apples}");  // output: Original: { Item = Apples, Price = 1.19 }
        var saleApples = apples with { Price = 0.79m };
        Console.WriteLine($"Sale: {saleApples}");  // output: Sale: { Item = Apples, Price = 0.79 }
    }
}

with 式の左側のオペランドは、レコード型にすることができます。 C# 10 以降では、with 式の左側のオペランドとして構造体型または 匿名型 を使用することもできます。

次の例に示すように、with 式の結果は、式のオペランドと同じランタイム型になります。

using System;

public class InheritanceExample
{
    public record Point(int X, int Y);
    public record NamedPoint(string Name, int X, int Y) : Point(X, Y);

    public static void Main()
    {
        Point p1 = new NamedPoint("A", 0, 0);
        Point p2 = p1 with { X = 5, Y = 3 };
        Console.WriteLine(p2 is NamedPoint);  // output: True
        Console.WriteLine(p2);  // output: NamedPoint { X = 5, Y = 3, Name = A }
    }
}

参照型のメンバーの場合、オペランドがコピーされるときにメンバー インスタンスへの参照のみがコピーされます。 コピーと元のオペランドの両方が、同じ参照型のインスタンスにアクセスできます。 次の例は、その動作を示します。

using System;
using System.Collections.Generic;

public class ExampleWithReferenceType
{
    public record TaggedNumber(int Number, List<string> Tags)
    {
        public string PrintTags() => string.Join(", ", Tags);
    }

    public static void Main()
    {
        var original = new TaggedNumber(1, new List<string> { "A", "B" });

        var copy = original with { Number = 2 };
        Console.WriteLine($"Tags of {nameof(copy)}: {copy.PrintTags()}");
        // output: Tags of copy: A, B

        original.Tags.Add("C");
        Console.WriteLine($"Tags of {nameof(copy)}: {copy.PrintTags()}");
        // output: Tags of copy: A, B, C
    }
}

カスタム コピー セマンティクス

すべてのレコード クラス型には、"コピー コンストラクター" があります。 "コピー コンストラクター" は、含んでいるレコード型の 1 つのパラメーターを持つコンストラクターです。 その引数の状態が新しいレコード インスタンスにコピーされます。 with 式の評価では、コピー コンストラクターが呼び出され、元のレコードに基づいて新しいレコード インスタンスがインスタンス化されます。 その後、新しいインスタンスは、指定された変更に従って更新されます。 既定では、コピー コンストラクターは暗黙的、つまり、コンパイラによって生成されます。 レコード コピーのセマンティクスをカスタマイズする必要がある場合は、必要な動作が含まれるコピー コンストラクターを明示的に宣言します。 次の例では、明示的なコピー コンストラクターを使用して前の例が更新されます。 新しいコピー動作では、レコードがコピーされるときにリスト参照ではなくリスト項目がコピーされます。

using System;
using System.Collections.Generic;

public class UserDefinedCopyConstructorExample
{
    public record TaggedNumber(int Number, List<string> Tags)
    {
        protected TaggedNumber(TaggedNumber original)
        {
            Number = original.Number;
            Tags = new List<string>(original.Tags);
        }

        public string PrintTags() => string.Join(", ", Tags);
    }

    public static void Main()
    {
        var original = new TaggedNumber(1, new List<string> { "A", "B" });

        var copy = original with { Number = 2 };
        Console.WriteLine($"Tags of {nameof(copy)}: {copy.PrintTags()}");
        // output: Tags of copy: A, B

        original.Tags.Add("C");
        Console.WriteLine($"Tags of {nameof(copy)}: {copy.PrintTags()}");
        // output: Tags of copy: A, B
    }
}

構造体型のコピー セマンティクスをカスタマイズすることはできません。

C# 言語仕様

詳細については、レコード機能提案メモの次のセクションを参照してください。

関連項目