Rust: Procedural Macros
Zusammenfassung
Kurz
Der vollständige Bericht erklärt Rust-Prozedurmakros und zeigt mit zwei Derive-Beispielen, wie Structs in URL-Abfragezeichenfolgen umgewandelt oder um Getter-Methoden ergänzt werden. Er stellt außerdem Projektaufbau und Hilfs-Crates vor; der Autor merkt an, dass Prozedurmakros aus seiner Sicht schwierig zu schreiben und zu debuggen sind.
Mittel
Der vollständige Bericht von Itsuki führt in Rust-Prozedurmakros ein, die Rust-Code erzeugen und mit `TokenStream` als Ein- und Ausgabe arbeiten. Er unterscheidet funktionsähnliche Makros, Attributmakros und Derive-Makros, konzentriert sich aber vor allem auf Letztere. Für ihre Entwicklung stellt er ein separates `proc-macro`-Crate sowie `syn` zum Parsen, `quote` zum Erzeugen von Code und `proc-macro2` als hilfreiche Werkzeuge vor.
Kurze Beispiele zeigen, wie ein funktionsähnliches Makro eine Funktion einfügt und ein Attributmakro seine Eingaben ausliest. Die beiden ausführlicheren Derive-Beispiele wandeln Struct-Felder entweder in eine URL-Abfragezeichenfolge um oder erzeugen Getter-Methoden für einzelne Felder. Der Bericht erläutert dafür das Parsen des Eingabe-TokenStreams, die Codeerzeugung und die Wiederholung von Codeblöcken mit `quote!`. Nicht-Struct-Eingaben werden in den Beispielen mit einem Kompilierfehler abgewiesen.
Der Autor verweist auf ein vollständiges Code-Repository. Der Artikel behandelt hauptsächlich die vorgestellten Struct-Fälle; die anderen Makroarten bleiben knapp. Der Autor berichtet außerdem aus eigener Erfahrung, dass Prozedurmakros schwer zu schreiben und zu debuggen seien und dass eine VS-Code-Fehlermeldung bei ihm nach einem Neustart verschwand.
Ausführlich lesen
Der vollständige Bericht ist eine Einführung des Autors Itsuki in Rust-Prozedurmakros. Der Autor beschreibt sie als Rust-Code, der Rust-Code erzeugt: Gedanklich wandeln sie einen Syntaxbaum in einen anderen um, arbeiten dabei aber praktisch mit `TokenStream` als Eingabe und Ausgabe. Er unterscheidet drei Arten: funktionsähnliche Makros mit `!`, Derive-Makros über `#[derive(...)]` und Attributmakros. Der Schwerpunkt liegt auf Derive-Makros; die beiden anderen Arten werden kurz anhand einfacher Beispiele vorgestellt.
Zunächst erklärt der Artikel die Projektstruktur: Prozedurmakros müssen in einem eigenen Crate mit dem Typ `proc-macro` definiert werden und lassen sich nicht im selben Crate verwenden, in dem sie definiert sind. Das Beispiel legt deshalb ein Anwendungs-Crate und darin ein Bibliotheks-Crate für die Makros an. Als Hilfsmittel empfiehlt der Autor `syn`, um TokenStreams in Rust-Syntaxbäume zu parsen, `quote`, um daraus wieder TokenStreams zu erzeugen, sowie `proc-macro2`, dessen Typen laut Artikel auch außerhalb des Makrokontexts nutzbar sind und Unit-Tests ermöglichen. AST Explorer wird als visuelles Hilfsmittel zum Betrachten der Syntaxbäume genannt.
Die kurzen Beispiele zu den ersten beiden Makroarten zeigen, wie eine öffentliche Funktion mit der jeweiligen Prozedurmakro-Attributmarkierung einen TokenStream entgegennimmt und einen TokenStream zurückgibt. Das funktionsähnliche `say_hello!` fügt eine Funktion ein. Das Attributmakro `log_info` gibt die übergebenen Attribut- und Element-TokenStreams aus und lässt das Element unverändert zurück. Dabei weist der Autor darauf hin, dass die Attribut-Eingabe die Tokens innerhalb der Attributklammern enthält, aber nicht die äußeren Klammern.
An zwei Derive-Beispielen erläutert der Bericht das Parsen und Erzeugen von Code. `IntoURLQueryString` verarbeitet Structs und implementiert für sie `From<Struct> for String`. Die generierte Implementierung fügt Feldnamen und URL-kodierte Werte zu einer Abfragezeichenfolge zusammen. Für Eingaben, die keine Structs sind, gibt das Beispiel einen Kompilierfehler aus. `URLQueryGetter` erzeugt stattdessen für jedes Feld eine eigene Getter-Methode, etwa `get_limit_query()`. Der Artikel erklärt dabei unter anderem die Einbettung zuvor definierter Variablen mit `#` in `quote!` und die Wiederholung von Code über `#(...)*`.
Als Ergebnis vermittelt der Bericht einen praktischen Einstieg mit Projektaufbau, Werkzeugen und Codebeispielen; der Autor verweist zusätzlich auf ein vollständiges Beispiel-Repository. Die Grenzen sind durch den beschriebenen Umfang gesetzt: Der Fokus liegt auf eigenen Derive-Makros und den gezeigten Struct-Beispielen, während funktionsähnliche und Attributmakros nur knapp behandelt werden. Der Autor bezeichnet Prozedurmakros aus eigener Sicht als schwierig zu schreiben und zu debuggen und sagt, er würde sie für eine eigene Anwendung wahrscheinlich nur einsetzen, wenn er eine Bibliothek für andere entwickle. Außerdem berichtet er von einer gelegentlichen Fehlermeldung zur Makroexpansion in VS Code, die bei ihm nach einem Neustart verschwand; dies ist seine persönliche Erfahrung.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Luna hat zwei Zusammenfassungen geliefert. Geprüft wurde die mittlere; die kurze ist ebenfalls treu, lässt aber die Hilfs-Crates und die Beispiele weitgehend aus. Es gab keine Sammel- oder Teilfragen, daher bleibt die Einordnung leer.
Im Bericht, aber nicht in der Zusammenfassung
- Die Regel, dass Prozedurmakros im Wurzel eines proc-macro-Crates definiert werden und im selben Crate nicht verwendbar sind, sondern nur in einem anderen Crate importiert werden können
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.