RULEXDB_SUBSCRIBE_RULE(3)

✨ RULEXDB_SUBSCRIBE_RULE ✨

okay so bestie, welcome to RULEXDB_SUBSCRIBE_RULE(3) — a page from the Library Functions Manual and honestly? it's giving "new rule just dropped" 💅 stay with me, it's short and slay.

---

🌸 NAME 🌸

rulexdb_subscribe_rule — store a new rule into the rulex database 🎀

---

🦋 SYNOPSIS 🦋

#include <rulexdb.h>

int rulexdb_subscribe_rule(RULEXDB *rulexdb, const char *src, int rule_type, unsigned int position);

---

💖 DESCRIPTION 💖

so rulexdb_subscribe_rule() literally just adds a brand new rule to the specified ruleset in the database that the rulexdb argument points at. that's the whole vibe. new rule, in the ruleset, periodt ✨

the argument src points to the text representation of the rule you wanna add — like, the actual rule as text, okay? 👑

the argument rule_type specifies the rule type. it may accept one of these iconic values:

• RULEXDB_LEXCLASS — this rule is the word classifier and should be added to the Classifiers dataset. it's the main character of word classification, no cap.
• RULEXDB_PREFIX — the rule should be added to the Prefix detectors ruleset. prefix girly pop 🎀
• RULEXDB_RULE — the rule should be treated as a general rule and added to the General rules dataset. just a regular queen living her regular life 🌸
• RULEXDB_CORRECTOR — this rule is a correction rule and should be added to the Correctors dataset. fixing things, as she should 💅

the argument position defines the position of the newly added rule in the ruleset. so:

• if it's 0, this rule is appended at the end of the ruleset (chill, she goes last)
• otherwise, the new rule will be inserted at the specified position (cut the line bestie, she's going in the middle 😭)

---

🔥 RETURN VALUE 🔥

rulexdb_subscribe_rule() returns RULEXDB_SUCCESS, which is zero, when it's a success 💖 — or a non-zero error code otherwise. so like, 0 = we ate, anything else = we did not eat 🙈

---

💀 ERRORS 💀

here's where it can go wrong, and ngl you need to know all of these:

• RULEXDB_FAILURE — the referenced database has not been opened, internal data structures are corrupted, or some other general failure has occurred. it's giving "everything is broken and we don't know why" 💀
• RULEXDB_EINVKEY — the argument position has a non-zero value, but it is out of the ruleset range that must be continuous. so the range has to be continuous, and your position was not. not slay.
• RULEXDB_EPARM — the argument rulexdb or rule_type has an invalid value. bad param, bad vibe 🚫
• RULEXDB_EACCESS — the database is not opened for updating. she's read-only rn, sorry bestie, you can't write to her 😭

---

🌈 SEE ALSO 🌈

go read these next, they're all connected, iykyk 🫶

• rulexdb_classify(3)
• rulexdb_close(3)
• rulexdb_dataset_name(3)
• rulexdb_discard_dictionary(3)
• rulexdb_discard_ruleset(3)
• rulexdb_fetch_rule(3)
• rulexdb_lexbase(3)
• rulexdb_load_ruleset(3)
• rulexdb_open(3)
• rulexdb_remove_item(3)
• rulexdb_remove_rule(3)
• rulexdb_remove_this_item(3)
• rulexdb_retrieve_item(3)
• rulexdb_search(3)
• rulexdb_seq(3)
• rulexdb_subscribe_item(3)

---

👑 AUTHOR 👑

written by Igor B. Poretsky <poretsky@mlbox.ru> — icon behavior, thank you for your service 🫡💜

---

and that's the page bestie!! 🌟 this was RULEXDB_SUBSCRIBE_RULE(3) from the Library Functions Manual, dated February 19, 2012 — go forth and subscribe those rules, you absolute legend 💅✨🎀