STAR::Writer(3pm)

💖 STAR::Writer(3pm) 💖

okay bestie, welcome to the STAR::Writer era of your life 🌟 this is the Perl extension that writes STAR::DataBlock objects out as files, and honestly? she serves. this is the doc for STAR::Writer(3pm) and we're gonna get you all the way together 🫶

🌸 Version

this documentation is talking about version 0.01 of this module. tiny number, big energy 💅

---

✨ SYNOPSIS ✨

use STAR::Writer;

STAR::Writer->write_cif( -dataref=>$data, -file=>$file );

that's it. that's the whole vibe. 🎀

---

🦋 DESCRIPTION 🦋

so basically this module is gonna hand you a bunch of methods for writing STAR::DataBlocks out as files, in different formats — she's versatile like that ✨

right now there's one method on the roster: write_cif, and what she does is write a STAR::DataBlock or STAR::Dictionary object as a file in CIF (STAR) format. that's the assignment and she ate. periodt. 🔥

---

👑 CLASS METHODS 👑

💫 write_cif

Usage:  STAR::Writer->write_cif( -dataref=>$data,
                                 -file=>$file [,
                                 -options=>$options ] );

here's the tea, no cap: write_cif takes the STAR::DataBlock object that $data points at and writes it to the file that $file points at. 🫶

and $options? those are little single-letter flags, bestie:

• l — for logging activity, and she logs to STDERR
• d — for debugging

that's it, that's the whole option menu. simple, iconic, lowkey perfect 💜

---

💀 COMMENTS 💀

ngl, there's a little situation here that you should know about: categories and items are currently written out in alphabetical order.

and listen — to automated parsing? literally zero importance. the parser does not care. 🙈

but if you're a human being visually inspecting these files with your own two eyes? sorting alphabetically might not be the move you want. so like… keep that in mind, okay? she said what she said 💅

---

🌈 AUTHOR 🌈

Wolfgang Bluhm, mail@wbluhm.com

🎀 Acknowledgments

big love and thank yous to Phil Bourne, Helge Weissig, Anne Kuller, Doug Greer, Michele Bluhm, and others — for support, help, and comments. the support system really said "we ride at dawn" and we love that for them 🫶🌸

---

⭐ COPYRIGHT ⭐

a full copyright statement is provided with the distribution. 📜

Copyright (c) 2000 University of California, San Diego

---

💜 SEE ALSO 💜

go check out her besties, they're all iconic iykyk:

• STAR::Parser
• STAR::Dictionary

---

that's the whole page bestie, you're now officially fluent in STAR::Writer 🌟 this was STAR::Writer(3pm) from perl v5.18.1, dated 2001-05-22 — written back when your favourite songs weren't even a glimmer in the timeline, and still eating 💖 bye ily, go write some CIF files 🦋✨