struct_annotation 0.0.0-dev.3 struct_annotation: ^0.0.0-dev.3 copied to clipboard
Experimental support for data classes in Dart using pkg:macros
struct_annotation #
🚧 Experimental 🚧
Experimental support for data classes in Dart using macros.
✨ Features #
🪨 const
constructors with required, named parameters
🖨️ copyWith
with optional, nullable, named parameters
✨ toString
for an improved string representation
☯️ operator==
and hashCode
for value equality
🧑💻 Example #
import 'package:struct_annotation/struct_annotation.dart';
@Struct()
class Person {
final String name;
final int age;
}
void main() {
// 🪨 Create a const instance with required, name parameters.
const jane = Person(name: 'Jane', age: 42);
// 🖨️ Create copies of your object.
final john = jane.copyWith(name: 'John');
// ✨ Human-readable string representation.
print(jane); // Person(name: Jane, age: 42)
print(john); // Person(name: John, age: 42)
// ☯️ Value equality comparisons.
print(jane == jane.copyWith()); // true
print(john == john.copyWith(age: 21)); // false
}
🚀 Quick Start #
-
Switch to the Flutter
master
channelflutter channel master
-
Add
package:struct_annotation
to yourpubspec.yaml
dependencies: struct_annotation: ^0.0.0-dev.1
-
Enable experimental macros in
analysis_options.yaml
analyzer: enable-experiment: - macros
-
Use the
@Struct
annotation (see above example). -
Run it
dart --enable-experiment=macros run main.dart
*Requires Dart SDK >= 3.5.0-152.0.dev