sander/rust-imap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix up metadata depth enum

Browse source
This commit is contained in:
Jon Gjengset 2021-03-06 09:48:22 -08:00
parent 9a24ca4125
commit 6fbbcb88f3
1 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/extensions/metadata.rs
View file

@ -26,19 +26,25 @@ impl CmdListItemFormat for Metadata {
} }
} }
/// Represents variants of DEPTH parameters for GETMETADATA command. /// Represents variants of the `DEPTH` parameter for the `GETMETADATA` command.
/// "0" - no entries below the specified entry are returned ///
/// "1" - only entries immediately below the specified entry are returned /// When a non-zero depth is specified with the `GETMETADATA` command, it extends the list of entry
/// "infinity" - all entries below the specified entry are returned /// values returned by the server. For each entry name specified in the `GETMETADATA` command, the
/// See [RFC 5464, section 4.2.2](https://tools.ietf.org/html/rfc5464#section-4.2.2) /// server returns the value of the specified entry name (if it exists), plus all entries below the
/// entry name up to the specified `DEPTH`.
///
/// See also [RFC 5464, section 4.2.2](https://tools.ietf.org/html/rfc5464#section-4.2.2).
#[derive(Debug, Copy, Clone)] #[derive(Debug, Copy, Clone)]
pub enum MetadataDepth { pub enum MetadataDepth {
/// Depth 0 for get metadata /// No entries below the specified entry are returned.
Zero, Zero,
/// Depth 1 for get metadata /// Only entries immediately below the specified entry are returned.
///
/// Thus, a depth of one for an entry `/a` will match `/a` as well as its children entries
/// (e.g., `/a/b`), but will not match grandchildren entries (e.g., `/a/b/c`).
One, One,
/// Depth infinity for get metadata /// All entries below the specified entry are returned
Inf, Infinity,
} }
impl Default for MetadataDepth { impl Default for MetadataDepth {
@ -52,7 +58,7 @@ impl MetadataDepth {
match self { match self {
MetadataDepth::Zero => return "0", MetadataDepth::Zero => return "0",
MetadataDepth::One => return "1", MetadataDepth::One => return "1",
MetadataDepth::Inf => return "infinity", MetadataDepth::Infinity => return "infinity",
} }
} }
} }
@ -159,7 +165,7 @@ mod tests {
&mut session, &mut session,
"", "",
&["/shared/vendor/vendor.coi", "/shared/comment"], &["/shared/vendor/vendor.coi", "/shared/comment"],
MetadataDepth::Inf, MetadataDepth::Infinity,
Option::None, Option::None,
); );