RoPkg:...eptions(3pm)

💖 RoPkg::Exceptions — the perl manpage, but make it cute ✨

okay bestie, this is RoPkg::Exceptions(3pm) from the User Contributed Perl Documentation corner of the internet, and we're about to have a whole moment about it. sit down, grab a strawberry 🍓, let's go.

---

🌸 NAME 🌸

RoPkg::Exceptions — exceptions used by RoPkg packages 💅

---

✨ DESCRIPTION ✨

So basically RoPkg::Exceptions is a collection of predefined exceptions used by all the modules from the RoPkg namespace. it's the shared emotional support exception library of the family, no cap 🫶

---

🎀 SYNOPSIS 🎀

here's the vibe, verbatim, don't touch anything:

#!/usr/bin/perl

use strict;
use warnings;

use RoPkg::Exceptions;

sub main {
  eval {
    if ( $#ARGV == -1 ) {
      Param::Missing->throw('No parameter found');
    }
  };

  if ( my $e = Exception::Class->caught('Param::Missing') ) {
    print STDERR $e->message,$/,$e->trace,$/;
  }
}

main();

ngl, it is very possible that you don't find a good reason for using exceptions from this example. and you are right — this example is kind of silly 🙈. but bestie, try to use exceptions in a real project. then you will apreciate their real value. trust. 🔥

---

🦋 DEPENDENCIES 🦋

RoPkg::Exceptions requires:

• perl 5.008 or later
• the Exception::Class module

that's it, that's the whole guest list ✨

---

👑 Exceptions List 👑

the following exceptions are defined in this class, and yes we're doing all of them:

• General — general pourpose exception 🌈
• OutsideClass — raised when a method is called outside a class instance 💀
• File — the base for all file related exceptions. this exception has the filename parameter, who can be used to specify the path to the file. filename parameter can be used by all derivated exceptions. the following exceptions are derivated from File:
  • File::NotFound — the file was not found 😭
  • File::Open — error while opening file 🙈
  • File::Create — could not create file
• Dir — the base for all directory related exceptions. this exception has the dirname parameter, who can be used to specify the path to the directory. dirname parameter can be used by all derivated exceptions. the following exceptions are derivated from Dir:
  • Dir::NotFound — the directory was not found 😭
  • Dir::Open — error while opening directory 🙈
  • Dir::Create — could not create directory
• Param — the base for all parameters related exceptions. this exception has the name parameter, who can be used to specify the parameter name. name can be used by all derivated exceptions. the following exceptions are derivated from Param:
  • Param::Missing — the parameter was not found
  • Param::Unknown — the parameter is unknown
  • Param::Wrong — the parameter has the wrong value or is not defined
• DB — the base for all database related exceptions. this exception has the following parameters: dsn, user and pass. this exception (and the ones derivated from her) are mostly used in RoPkg::DB class. of course, this doesn't means that you can't use them in your application ;) .The following exceptions are derivated from DB:
  • DB::Connect — raised when the connection with the database could not be established 🔌
  • DB::ConnExists — raised when a connection with the same name already exists. 👯
  • DB::ConnNotFound — the requested connection was not found
  • DB::NoResults — the sql query returned no results 💀

---

🧚 Exceptions Tree 🧚

look at the family tree, it's giving ancestral slay:

ROOT
  General
  OutsideClass
  File
         File::NotFound
         File::Open
         File::Create
  Dir
         Dir::NotFound
         Dir::Open
         Dir::Create
  Param
         Param::Missing
         Param::Unknown
         Param::Wrong
  DB
         DB::Connect
         DB::ConnExists
         DB::ConnNotFound
         DB::NoResults

---

🌈 SEE ALSO 🌈

• RoPkg::Utils

go read that one too bestie, it's the sibling 💜

---

💜 AUTHOR 💜

Subredu Manuel <diablo@iasi.roedu.net> 👑

---

⭐ VERSION ⭐

the current version is 0.2.1 🎀

---

🔥 DIAGNOSTICS 🔥

the tests for this module are located in t directory. to run those tests, use the following command:

make test

and then watch them pass. iconic behaviour only ✨

---

💅 SUBROUTINES/METHODS 💅

this module does not have any public methods. it's mysterious. it's lowkey main character energy. it simply is 🦋

---

🫶 INCOMPATIBILITIES 🫶

None known to me 🤷

---

🎀 PERL CRITIC 🎀

this module is perl critic level 1 compliant with 1 exception. so close to perfect, honestly relatable 💀

---

😭 BUGS AND LIMITATIONS 😭

No known bugs. if you find one (or many) please send me a detailed report. and bestie, be detailed, don't just say "it's broken" 🙏

---

🌸 CONFIGURATION AND ENVIRONMENT 🌸

No configuration file or environment variables are used by this module. nothing to set up, nothing to export, just vibes ✨

---

💖 LICENSE AND COPYRIGHT 💖

Copyright (C) 2005 Subredu Manuel. All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license. periodt. 💅

---

and that's the whole page, bestie 🫶 this was RoPkg::Exceptions(3pm), rendered by perl v5.32.1 on 2021-12-26. mwah 💋 🎀