Record structs in C Sharp (C#)

Introduction

Record structs let you create small, simple data containers that are easy to compare and print. They combine the benefits of structs and records.

When you want a lightweight data type that holds related values together.

When you need value-based equality to compare two data objects easily.

When you want to print or log data objects with a clear, readable format.

When you want to avoid the overhead of classes but still want immutability.

When you want to pass small data around without worrying about references.

Syntax

C Sharp (C#)

public record struct Point(int X, int Y);

This defines a record struct named Point with two properties: X and Y.

Record structs provide built-in methods like ToString(), Equals(), and GetHashCode() based on the data.

Examples

A simple record struct with two integer properties.

C Sharp (C#)

public record struct Point(int X, int Y);

Shows that two record structs with the same data are equal.

C Sharp (C#)

var p1 = new Point(3, 4);
var p2 = new Point(3, 4);
Console.WriteLine(p1 == p2);

Record struct with string and int properties, printing shows property names and values.

C Sharp (C#)

public record struct Person(string Name, int Age);

var person = new Person("Alice", 30);
Console.WriteLine(person);

Sample Program

This program creates three points using a record struct. It prints one point, then compares points for equality.

C Sharp (C#)

using System;

public record struct Point(int X, int Y);

class Program
{
    static void Main()
    {
        var point1 = new Point(5, 10);
        var point2 = new Point(5, 10);
        var point3 = new Point(7, 8);

        Console.WriteLine(point1); // Prints the data nicely
        Console.WriteLine(point1 == point2); // True, same data
        Console.WriteLine(point1 == point3); // False, different data
    }
}

Important Notes

Record structs are value types, so they are stored on the stack or inline in other objects.

They automatically provide Equals and GetHashCode based on their data, making comparisons easy.

You can add methods or properties to record structs just like normal structs.

Summary

Record structs combine the simplicity of structs with the helpful features of records.

They make it easy to create small data containers with built-in equality and nice printing.

Use them when you want lightweight, immutable data types with value-based behavior.

Practice

1. What is a key feature of record struct in C#?

easy

A. It provides value-based equality and immutability by default.

B. It allows inheritance from other structs.

C. It can only be used for reference types.

D. It does not support property declarations.

Solution

1. Step 1: Understand record struct purpose

   Record structs combine struct's lightweight nature with record's value-based equality and immutability.

2. Step 2: Analyze options

   It provides value-based equality and immutability by default. correctly states value-based equality and immutability. Options B, C, and D are incorrect because structs cannot inherit, record structs are value types, and they support properties.

3. Final Answer:

   It provides value-based equality and immutability by default. -> Option A

4. Quick Check:

   record struct = value equality + immutability [OK]

Hint: Remember: record structs behave like immutable value containers [OK]

Common Mistakes:

• Thinking record structs support inheritance
• Confusing record structs with classes
• Assuming record structs are reference types

2. Which of the following is the correct syntax to declare a record struct named Point with two properties X and Y of type int?

easy

A. struct record Point { int X; int Y; }

B. record Point struct { int X; int Y; }

C. record struct Point(int X, int Y);

D. record struct Point { int X; int Y; }

Solution

1. Step 1: Recall record struct declaration syntax

   The concise syntax for record structs uses positional parameters: record struct Name(type prop1, type prop2);

2. Step 2: Compare options

   record struct Point(int X, int Y); matches the correct syntax. record struct Point { int X; int Y; } is close but missing parentheses for positional parameters. Options A and C have incorrect order or keywords.

3. Final Answer:

   record struct Point(int X, int Y); -> Option C

4. Quick Check:

   record struct with positional params = record struct Point(int X, int Y); [OK]

Hint: Use parentheses for positional properties in record structs [OK]

Common Mistakes:

• Swapping 'record' and 'struct' keywords
• Omitting parentheses for positional parameters
• Using braces instead of parentheses for positional syntax

3. What will be the output of the following code?

record struct Point(int X, int Y);
var p1 = new Point(3, 4);
var p2 = new Point(3, 4);
Console.WriteLine(p1 == p2);

medium

A. True

B. False

C. Compilation error

D. Runtime exception

Solution

1. Step 1: Understand equality in record structs

   Record structs provide value-based equality by default, so two instances with same values are equal.

2. Step 2: Analyze the code output

   Both p1 and p2 have X=3 and Y=4, so p1 == p2 evaluates to true.

3. Final Answer:

   True -> Option A

4. Quick Check:

   record struct equality = value equality [OK]

Hint: Record structs compare values, not references [OK]

Common Mistakes:

• Assuming == compares references for structs
• Expecting compilation error for == operator
• Confusing record structs with classes for equality

4. Identify the error in this code snippet:

record struct Rectangle(int Width, int Height);
var rect = new Rectangle(5, 10);
rect.Width = 7;
Console.WriteLine(rect);

medium

A. Rectangle must be a class to allow property assignment.

B. Missing semicolon after record struct declaration.

C. Console.WriteLine cannot print record structs.

D. Cannot assign to 'Width' because it is readonly.

Solution

1. Step 1: Understand immutability of record structs

   Record structs with positional parameters generate readonly properties by default.

2. Step 2: Analyze the assignment line

   Trying to assign rect.Width = 7; causes a compile-time error because Width is readonly.

3. Final Answer:

   Cannot assign to 'Width' because it is readonly. -> Option D

4. Quick Check:

   Positional record struct properties are readonly [OK]

Hint: Positional record struct properties are readonly by default [OK]

Common Mistakes:

• Trying to modify readonly properties
• Confusing record structs with mutable classes
• Ignoring compiler error messages

5. You want to create a lightweight data type to store a 3D point with coordinates X, Y, and Z. You want it to be immutable, support value equality, and print nicely. Which is the best way to declare it using record structs?

hard

A. struct Point3D { public int X; public int Y; public int Z; }

B. record struct Point3D(int X, int Y, int Z);

C. class Point3D { public int X { get; set; } public int Y { get; set; } public int Z { get; set; } }

D. record class Point3D(int X, int Y, int Z);

Solution

1. Step 1: Identify requirements

   Needs lightweight, immutable, value equality, and nice printing.

2. Step 2: Match requirements to options

   record struct Point3D(int X, int Y, int Z); uses record struct with positional parameters, providing all requirements. struct Point3D { public int X; public int Y; public int Z; } is mutable struct without value equality or nice printing. class Point3D { public int X { get; set; } public int Y { get; set; } public int Z { get; set; } } is mutable class, heavier and reference type. record class Point3D(int X, int Y, int Z); is record class, reference type, not lightweight.

3. Final Answer:

   record struct Point3D(int X, int Y, int Z); -> Option B

4. Quick Check:

   record struct = lightweight + immutable + value equality [OK]

Hint: Use record struct with positional params for immutable lightweight data [OK]

Common Mistakes:

• Choosing class instead of struct for lightweight data
• Using mutable fields instead of readonly properties
• Confusing record class with record struct