JSON::...::Error(3pm)

✨ NAME ✨

JSON::RPC::Common::Procedure::Return::Error — bestie, it's the base class for all the JSON-RPC errors 💖 (and yeah the man page header just calls it JSON::...::Error(3pm) because man page headers are cowards who truncate, but you and me? we know her full name 👑)

---

🌸 VERSION 🌸

version 0.11 — that's the one, no cap 💅

---

🎀 SYNOPSIS 🎀

okay so here's the whole vibe, literally copy-paste this:

use JSON::RPC::Common::Procedure::Return::Error;

my $error = JSON::RPC::Common::Procedure::Return::Error->new(
        message => "foo",
        code => "bah",
);

# or construct a return with an error from a call:
my $return = $call->return_error("foo");

$return->error->message;

see how she did that? new with a message and a code, or just slide in via $call->return_error("foo") and grab $return->error->message like it's nothing 🫶

---

🦋 DESCRIPTION 🦋

This is a base class for all version specific error implementations. That's it. That's the whole job. She's the mother of all error classes and she is serving main character energy without even trying ✨

---

💜 ATTRIBUTES 💜

• code
• message
• data

These three are the common JSON-RPC error fields, fr fr 🍓

In JSON-RPC 1.1, "data" is known as "error", and in 1.0 none of this is specced at all 💀 (yes bestie, 1.0 said "no thoughts, head empty" and we respect that, but also 😭)

Go peep the version specific subclasses for the various behaviors, because they each do their own little thing ✨

Oh and heads up: code is an integer, and message is a string. Don't be out here passing vibes where an integer goes 🙈

---

🌈 METHODS 🌈

• new_dwim — convenience constructor used by "return_error" in JSON::RPC::Common::Procedure::Call 🎀 Will return an object if that's the argument, and otherwise construct an error. Like, she reads the room. If you hand her an object she gives it right back, if you hand her anything else she makes you a fresh error. Versatile queen 💅
• inflate — create an error object from JSON data (not text) 🦋 In order to maximize compatibility this inflation routine is very liberal in what it accepts — she is not picky, she says yes to almost everything, she's the friendliest bouncer you've ever met 😌

---

💖 AUTHOR 💖

Yuval Kogman <nothingmuch@woobling.org> — legend behavior, honestly 🌟

---

👑 COPYRIGHT AND LICENSE 👑

This software is copyright (c) 2014 by Yuval Kogman and others 💖

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Slay, open source, we love to see it 🌸

---

okay bestie that's the whole page, you're so ready 💅 go forth and error correctly ✨

perl v5.30.3 · 2020-06-23 · and that's the <pink>JSON::...::Error(3pm)</pink> sign-off, mwah 🎀🫶💖