Travel...essage(3pm)

📦
version 2.24 · 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

okay so bestie, welcome to Travel::Routing::DE::EFA::Route::Message (it's a Perl module, it lives in Travel...essage(3pm) land) — she's the lil cutie that holds a message related to a route or route part. that's the whole job. 💖

🌸 SYNOPSIS 🌸

here's how you actually use her, fr fr:

for my $m ($routepart->regular_notes, $routepart->current_notes) {
    if ($m->is_detailed) {
        printf("%s: %s\n", $m->subtitle, $m->subject);
    }
    else {
        say $m->summary;
    }
}

🎀 VERSION 🎀

version 2.24 — yes she's got a version number, she's that girl.

💅 DESCRIPTION 💅

Travel::Routing::DE::EFA::Route::Message carries the tea about a specific route or route part — think wheelchair accessibility, unscheduled route diversions, cancelled stops, all of it. and here's the spicy part: this info often isn't even used in the backend's route calculation, so a message may invalidate a certain route or route part. like, she can just end a whole route's career. 💀

there are two types of messages the backend hands out: oneliners and detailed messages. and ngl, there's no known distinction between them regarding their type or content. also — heads up — there are some other backend-provided fields that this module does not cover yet, so expect changes in future releases. she's growing, ok? 🌱

a oneline message is literally just one single string, and you get to it via subject or summary, and its is_detailed accessor returns false.

a detailed message has a subject, subtitle, summary and detailed HTML content. the full package. 💅

👑 METHODS 👑

ACCESSORS

  • $message->is_detailed — true if all accessors (fields) are set, false otherwise. when this field is false, only summary and subject are set (and bestie, they'll return the same string).
  • $message->summary — the message summary. short and sweet.
  • $message->subject — the message subject. may be the same string as the subtitle.
  • $message->subtitle — the message subtitle. may be the same string as the summary.
  • $message->raw_content — the raw HTML content. this one may contain info that you can't get from any other accessor. she's got secrets. 🙈

😭 DIAGNOSTICS 😭

None.

like... none at all. she's chill. 🧘

🦋 DEPENDENCIES 🦋

None.

she's self-sufficient, a true independent icon. ✨

💀 BUGS AND LIMITATIONS 💀

this module does not yet provide access to all data provided by the backend. most notably, raw_content is not properly parsed yet. so yeah, it's giving "work in progress", but we love her anyway. 🫶

🌈 SEE ALSO 🌈

go read those too, iykyk. 📚

💜 AUTHOR 💜

Copyright (C) 2015 by Birte Kristina Friesel <derf@finalrewind.org>

shoutout to Birte, absolute legend, we stan. 👑

🍓 LICENSE 🍓

This program is licensed under the same terms as Perl itself.

ok that's the whole page bestie, no cap. go forth and read your messages. 💖

this was perl v5.36.0 from 2023-11-27 — and honestly? the manual name was Travel...essage(3pm) the whole time. slay, mwah, bye. 💅✨

📦 where this page comes from