docs: update readme

This commit is contained in:
Anna 2018-03-31 17:13:50 -04:00
parent 8e5f77b98f
commit 17aa20a033
1 changed files with 11 additions and 12 deletions

View File

@ -4,20 +4,19 @@ These are useful types when working with FFXIV.
Up to date as of *patch 4.25*.
- `DataCenter`
- `World`
- `Role`
- `Job`
- `DataCenter` (feature `data_centers`)
- `World` (feature `worlds`)
- `Role` (feature `roles`)
- `Job` (feature `combat_jobs`)
- `NonCombatJob` (feature `non_combat_jobs`)
- `Classification` (feature `job_classifications`)
`Job`, `NonCombatJob`, and `Classification` can all be simultaneously enabled with feature `jobs`.
All types implement `Debug`, `Display`, `Clone`, `Copy`, and `FromStr`.
With feature `with_serde`, all types also implement `Serialize` and `Deserialize`.
They also all have a `fn as_str(&self) -> &'static str`.
They all have a `ALL` const (e.g. `Job::ALL`).
Individual methods:
- `Job`
- `fn role(&self) -> Role`
- `World`
- `fn data_center(&self) -> DataCenter`
With feature `all_const`, they all have an `ALL` const (e.g. `Job::ALL`).