NetSDS::Conf(3pm)

πŸ“¦
version 1.301 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute

πŸ’– NetSDS::Conf β€” the vibe πŸ’–

okay so bestie, welcome to NetSDS::Conf(3pm), part of the User Contributed Perl Documentation collection. it's a whole module, it's giving config-file energy, and we're gonna get through it together. πŸŽ€


✨ NAME ✨

NetSDS::Conf β€” the API to configuration files. that's it, that's the whole job. πŸ‘‘


✨ SYNOPSIS ✨

here's the whole mood in code, no notes:

use NetSDS::Conf;

my $cf = NetSDS::Conf->getconf($conf_file);
my $val = $cf->{'parameter'};

literally three lines. use it, grab the conf, read your parameter. slay. πŸ’…


✨ DESCRIPTION ✨

so NetSDS::Conf is a wrapper around the Config::General handler, specifically for NetSDS configuration files. it's a little middleman, a lil matchmaker between you and your conf file. πŸ¦‹

lowkey important: this package is for internal usage only, fr fr. it gets called from NetSDS::App or from modules that inherit from it, and it should never be used directly from applications. like, ever. it's not for you like that. πŸ™ˆ

🌸 getconf() β€” read parameters from configuration file 🌸

  • Parameters: configuration file name
  • Returns: cofiguration as hash reference

this method tries to read the configuration file and fill object properties with the read values.

NOTE: parameters set from the command line will not be overriden. periodt. the CLI wins, always. πŸ‘‘

✨ EXAMPLES ✨

...yeah there's nothing here bestie. the section exists, the content does not. it's giving empty notebook, main character about to write her story. πŸ’€πŸŽ€


✨ BUGS ✨

Unknown

...iconic honestly. no known bugs, or at least nobody's fessing up. we're choosing to believe it's the first one. 😭✨


✨ SEE ALSO ✨

go read these too, they're the friend group:

  • Getopt::Long
  • Config::General
  • NetSDS::Class::Abstract

✨ TODO ✨

  1. Improve documentation.

that's the whole list. one item. a single to-do. and honestly? relatable. we all have that one thing we keep meaning to get to. 🫢


✨ AUTHOR ✨

Michael Bochkaryov <misha@rattler.kiev.ua>

thank you for your service, king. πŸ‘‘


and that's the whole page, bestie!! πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈ no cap, you now know NetSDS::Conf better than you knew it five minutes ago. this was perl v5.32.1, dated 2021-12-26, and it's been an absolute honor. go forth, read your configs, and remember: don't call this module directly. i'm serious. bye bestie!! πŸ«ΆπŸ’…πŸŒˆ