ffxiv-types/README.md

23 lines
710 B
Markdown
Raw Permalink Normal View History

2018-03-29 00:44:30 +00:00
# ffxiv_types
These are useful types when working with FFXIV.
2022-07-04 14:17:07 +00:00
Up to date as of *patch 6.18*.
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
- `DataCenter` (feature `data_centers`)
- `World` (feature `worlds`)
- `Role` (feature `roles`)
- `Job` (feature `combat_jobs`)
- `NonCombatJob` (feature `non_combat_jobs`)
- `Classification` (feature `job_classifications`)
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
`Job`, `NonCombatJob`, and `Classification` can all be simultaneously enabled with feature `jobs`.
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
All types implement `Debug`, `Display`, `Clone`, `Copy`, and `FromStr`.
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
With feature `with_serde`, all types also implement `Serialize` and `Deserialize`.
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
They also all have a `fn as_str(&self) -> &'static str`.
2018-03-29 00:44:30 +00:00
2018-03-31 21:13:50 +00:00
With feature `all_const`, they all have an `ALL` const (e.g. `Job::ALL`).