SVN::N...figData(3pm)

πŸ“¦
version 0.04000 Β· 2 versions
  • 0.04000 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.04000 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– SVN::Notify::Mirror::ConfigData β€” the whole vibe

okay bestie, welcome to SVN::Notify::Mirror::ConfigData, straight out of your friendly neighbourhood User Contributed Perl Documentation πŸŽ€ this is the little config-holder that lives inside SVN::Notify::Mirror and, like, keeps all its settings safe. it's a Perl module. it's three-ish lines of docs away from being a whole personality. let's get into it πŸ¦‹


✨ NAME ✨

SVN::Notify::Mirror::ConfigData β€” the configuration hub for SVN::Notify::Mirror, no cap πŸ’…


✨ SYNOPSIS ✨

here's the whole group chat, in code form:

use SVN::Notify::Mirror::ConfigData;
$value = SVN::Notify::Mirror::ConfigData->config('foo');
$value = SVN::Notify::Mirror::ConfigData->feature('bar');

@names = SVN::Notify::Mirror::ConfigData->config_names;
@names = SVN::Notify::Mirror::ConfigData->feature_names;

SVN::Notify::Mirror::ConfigData->set_config(foo => $new_value);
SVN::Notify::Mirror::ConfigData->set_feature(bar => $new_value);
SVN::Notify::Mirror::ConfigData->write;  # Save changes

like, you can read stuff, you can write stuff, you can even ask for a full list of names. iconic behaviour tbh ✨


✨ DESCRIPTION ✨

so this module holds the configuration data for the SVN::Notify::Mirror module. it also hands you a programmatic interface for getting or setting that configuration data β€” very main character of it 🫢

⚠️ but listen: to actually make changes, you have to have write access to the SVN::Notify::Mirror::ConfigData module. and you should attempt to understand the repercussions of your actions. yes, repercussions. the docs said it, not me 😭

✨ METHODS ✨

  • config($name) β€” you give it a string, it gives you back the value of the configuration item with that name. if that item doesn't exist? you get undef. that's it, that's the whole deal πŸ’œ
  • feature($name) β€” same energy, but for features: hand it a string, it hands you the value of the feature by that name. no such feature? undef, bestie πŸ™ˆ
  • set_config($name, $value) β€” sets the configuration item with the given name to the given value. the value can be any Perl scalar that will serialize correctly using Data::Dumper β€” and yes that includes references, objects (usually), and complex data structures. it probably does not include transient things like filehandles or sockets, so don't try it πŸ“
  • set_feature($name, $value) β€” sets the feature with the given name to the given boolean value. the value gets converted to 0 or 1 automatically, so you don't gotta worry about it ✨
  • config_names() β€” returns a list of all the names of config items currently defined in SVN::Notify::Mirror::ConfigData. and if you call it in scalar context? you get the number of items instead. two moods, one method πŸ’…
  • feature_names() β€” same thing but for features: a list of all the names of features currently defined in SVN::Notify::Mirror::ConfigData, or in scalar context the number of features 🌸
  • auto_feature_names() β€” returns a list of all the names of features whose availability is dynamically determined, or in scalar context the number of such features. careful though: it does not include such features that have later been set to a fixed value πŸ‘‘ iykyk
  • write() β€” commits any changes from set_config() and set_feature() to disk. and yeah, it requires write access to the SVN::Notify::Mirror::ConfigData module. no write access, no slay πŸ’€

✨ AUTHOR ✨

SVN::Notify::Mirror::ConfigData was automatically created using Module::Build. Module::Build was written by Ken Williams, but he holds no authorship claim or copyright claim to the contents of SVN::Notify::Mirror::ConfigData. so like, it's auto-generated, it said what it said, and Ken is fully unbothered 🧚


and that's the whole page, bestie!! πŸŽ€ this lil doc ships with perl v5.34.0 and was dated 2022-06-17 β€” stay config'd, stay caffeinated, and go read your own config files with love πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from