diff options
| author | Radosław Kot <rdkt13@gmail.com> | 2021-07-31 21:23:35 +0200 |
|---|---|---|
| committer | Radosław Kot <rdkt13@gmail.com> | 2021-10-23 16:58:41 +0200 |
| commit | bb23458eb91c3c62a50b5a8bc9dccbcf902ff070 (patch) | |
| tree | d7025dbc0c7cfc2ca3e217a63ef82402fd45d3a1 /src/file/format/mod.rs | |
| parent | 4775107810cbc7e045f075586e5061ed8aa51398 (diff) | |
Add documentation to file related types
Diffstat (limited to 'src/file/format/mod.rs')
| -rw-r--r-- | src/file/format/mod.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/file/format/mod.rs b/src/file/format/mod.rs index d1a9a71..4238227 100644 --- a/src/file/format/mod.rs +++ b/src/file/format/mod.rs @@ -26,6 +26,9 @@ mod ron; #[cfg(feature = "json5")] mod json5; +/// File formats provided by the library. +/// +/// Although it is possible to define custom formats using [`Format`] trait it is recommended to use FileFormat if possible. #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)] pub enum FileFormat { /// TOML (parsed with toml) |