Tedd.ReadOnlyStructGenerator 1.0.8

Tedd.ReadOnlyStructGenerator

.NET Source Generator for duplicating structs to read-only copies.

Adding [GenerateReadOnlyStruct] to a struct like this

namespace Example;

[GenerateReadOnlyStruct]
public struct Test
{
    public float X;
    public float Y;
    public float Z;
}

will inject this code into your project

#define RO_GEN

// This file was generated by Tedd.StructCopyGenerator
namespace Example
{
    [GenerateReadOnlyStruct]
    public readonly struct ReadOnlyTest
    {
        public readonly float X;
        public readonly float Y;
        public readonly float Z;
        public ReadOnlyTest(Test value)
        {
            X = value.X;
            Y = value.Y;
            Z = value.Z;
        }

        public ReadOnlyTest(float x, float y, float z)
        {
            this.X = x;
            this.Y = y;
            this.Z = z;
        }
    }
}

[GenerateReadOnlyStruct] takes two boolean parameters:

• GenerateConstructor
• GenerateCopyConstructor

This allows you to prevent constructors from being generated, in case you already have that implemented.

namespace Example;

[GenerateReadOnlyStruct(GenerateConstructor: false, GenerateCopyConstructor: false)]
// Or just [GenerateReadOnlyStruct(false, false)]
public struct Test
{
    public float X;
    public float Y;
    public float Z;

    public Test(float x, float y, float z)
    {
        this.X = x;
        this.Y = y;
        this.Z = z;
    }
}

will inject this code into your project

#define RO_GEN

// This file was generated by Tedd.StructCopyGenerator
namespace Example
{
    [GenerateReadOnlyStruct(GenerateConstructor: false, GenerateCopyConstructor: false)]
    public readonly struct ReadOnlyTest
    {
        public readonly float X;
        public readonly float Y;
        public readonly float Z;
        public ReadOnlyTest(float x, float y, float z)
        {
            this.X = x;
            this.Y = y;
            this.Z = z;
        }
    }
}

The constant RO_GEN is defined for every copy. It can be used for customizing code.

namespace Example;

using System.Numerics;

[GenerateReadOnlyStruct(false, false)]
public struct Test
{
    public float X;
    public float Y;
    public float Z;

    public Test(float x, float y, float z)
    {
        this.X = x;
        this.Y = y;
        this.Z = z;
    }
    
    public Vector3 Vector3 {
        get => new Vector3(X, Y, Z);
#if !RO_GEN
        // This section is only applicable for the mutable version of this struct
        set {
            X = value.X;
            Y = value.Y;
            Z = value.Z;
        }
#endif
    }
}

will essentially inject this code into your project. Note that preprocessor directives such as #if !RO_GEN are retained in the generated code, but since #define RO_GEN is added to the top of the file, the enclosed code is excluded from compilation.

#define RO_GEN

// This file was generated by Tedd.StructCopyGenerator
namespace Example
{
    using System.Numerics;

    [GenerateReadOnlyStruct(false, false)]
    public readonly struct ReadOnlyTest
    {
        public readonly float X;
        public readonly float Y;
        public readonly float Z;
        public ReadOnlyTest(float x, float y, float z)
        {
            this.X = x;
            this.Y = y;
            this.Z = z;
        }

        public Vector3 Vector3
        {
            get => new Vector3(X, Y, Z);
#if !RO_GEN
            // This section is only applicable for the mutable version of this struct
            set {
                X = value.X;
                Y = value.Y;
                Z = value.Z;
            }
#endif
        }
    }
}