leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Adjusted readme

Browse Source
This commit is contained in:
Leonetienne 2021-06-05 12:19:41 +02:00
parent e01d44393b
commit 93d6189a48
1 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@ -190,10 +190,8 @@ int main(int argc, char** argv)
Hazelnupp args; Hazelnupp args;
// Register constraints // Register constraints
args.RegisterConstraints({ args.RegisterConstraint("--this-is-required", ParamConstraint::Require()); // This missing throws an exception
ParamConstraint::Require("--this-is-required"), // This missing throws an exception args.RegisterConstraint("--also-required-but-defaulted", ParamConstraint::Require({"122"})); // This will default to 122
ParamConstraint::Require("--also-required-but-defaulted", {"122"}), // This will default to 122
});
// Parse // Parse
args.Parse(argc, argv); args.Parse(argc, argv);
@ -228,9 +226,7 @@ int main(int argc, char** argv)
Hazelnupp args; Hazelnupp args;
// Register constraints // Register constraints
args.RegisterConstraints({ args.RegisterConstraint("--this-must-be-int", ParamConstraint::TypeSafety(DATA_TYPE::INT));
ParamConstraint::TypeSafety("--this-must-be-int", DATA_TYPE::INT)
});
// Parse // Parse
args.Parse(argc, argv); args.Parse(argc, argv);
@ -245,13 +241,12 @@ If it was passed, for example, as a string, it would throw an exception.
Note that you can also combine these two constraint-types by populating the struct yourself: Note that you can also combine these two constraint-types by populating the struct yourself:
```cpp ```cpp
ParamConstraint pc; ParamConstraint pc;
pc.key = "--my-key";
pc.constrainType = true; pc.constrainType = true;
pc.wantedType = DATA_TYPE::STRING; pc.wantedType = DATA_TYPE::STRING;
pc.defaultValue = {}; // no default value pc.defaultValue = {}; // no default value
pc.required = true; pc.required = true;
args.RegisterConstraints({pc}); args.RegisterConstraints("--my-key", pc);
``` ```
What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in **one** struct. What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in **one** struct.