README.md

TypeWrap

This library utilizes Roslyn Source Generator to generate type wrappers for any C# type.

Features

• Any C# type can be wrapped, with an exception of dynamic.
• Wrappers can be a struct, a class, or a record.
  • A record wrapper can also be generic if needed.
• Wrappers have implicit and explicit operators to convert between itself and the original type.
• All public members of the original type are exposed in the wrapper. Supported members are fields, properties, events, indexers, methods, and operators.
• IEquatable<T> and IComparable<T> are implemented for the wrapper if the original type allows them.
• Equality operators (==, !=) are overloaded for the wrapper if the original type allows them.

Installation

Requirements

• Unity 2022.3 or later

Unity Package Manager

1. Open menu Window -> Package Manager.

2. Click the + button at the top-left corner, then choose Add package from git URL....

   

3. Enter the package URL https://github.com/laicasaane/TypeWrap/tree/main/Packages/TypeWrap.

OpenUPM

1. Install OpenUPM CLI.
2. Run the following command in your Unity project root directory:

openupm add com.laicasaane.typewrap

Usage

[WrapType] Attribute

• Use this attribute if the wrapper itself is either a struct or a class.
  • In case of a class, it must not inherit from any other class.
  • The wrapper must be partial.
• By default, the underlying type name is value. You can change it by specifying the memberName argument.
• By default, a type converter is generated for the wrapper. You can exclude it by specifying the ExcludeConverter property.

[WrapType(typeof(int))]
public partial struct IntWrapper { }

[WrapType(typeof(List<int>), memberName: "wrappedList")]
public partial class ListInt { }

[WrapType(typeof(IDisposable), ExcludeConverter = true)]
public readonly partial struct DisposableObject { }

[WrapRecord] Attribute

• Use this attribute if the wrapper itself is either a record struct or a record class.
  • In case of a record class, it must not inherit from any other class.
  • The wrapper must be partial.
• The primary constructor of the record must have exactly 1 parameter.
• By default, a type converter is generated for the wrapper. You can exclude it by specifying the ExcludeConverter property.

[WrapRecord(ExcludeConverter = true)]
public partial record struct IntWrapper(int Value);

[WrapRecord]
public partial record class ListT<T>(List<T> _);

[WrapRecord]
public readonly partial record struct Coord2D(Vector2Int _);

Notes

• To have record in Unity, you need to use Unity 2022.3 or later, and enable C# 10 feature by placing this csc.rsp file in your Assets folder: https://github.com/laicasaane/TypeWrap/blob/main/Assets/csc.rsp

• To have readonly record in any assembly (or .asmdef), you have to declare this class inside that assembly:

  namespace System.Runtime.CompilerServices
  {
      [ComponentModel.EditorBrowsable(ComponentModel.EditorBrowsableState.Never)]
      class IsExternalInit { }
  }

• You might also want to place this file in your Assets and the root of your project to enable the C# 10 feature for the code editor: https://github.com/laicasaane/TypeWrap/blob/main/Directory.Build.props