io-m2dir 0.1.0

//! Flags set associated with an m2dir entry.

use core::fmt;

use alloc::{
    collections::BTreeSet,
    string::{String, ToString},
    vec::Vec,
};

/// Set of flags attached to an m2dir entry.
///
/// Each flag is an arbitrary UTF-8 string; serialization to the
/// `.meta/<id>.flags` metadata file is one flag per line.
#[derive(Clone, Debug, Default, Eq, Ord, PartialEq, PartialOrd)]
pub struct M2dirFlags(BTreeSet<String>);

impl M2dirFlags {
    /// Returns an iterator over the flags in this set.
    pub fn iter(&self) -> impl Iterator<Item = &str> {
        self.0.iter().map(String::as_str)
    }

    /// Returns the number of flags in this set.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Returns `true` if the set contains no flags.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Inserts a flag into the set. Returns `true` if it was not
    /// already present.
    pub fn insert(&mut self, flag: impl Into<String>) -> bool {
        self.0.insert(flag.into())
    }

    /// Removes a flag from the set. Returns `true` if it was present.
    pub fn remove(&mut self, flag: &str) -> bool {
        self.0.remove(flag)
    }

    /// Returns `true` if the set contains the given flag.
    pub fn contains(&self, flag: &str) -> bool {
        self.0.contains(flag)
    }

    /// Adds every flag from `flags` to this set.
    pub fn extend(&mut self, flags: M2dirFlags) {
        self.0.extend(flags.0);
    }

    /// Removes every flag in `flags` from this set.
    pub fn difference(&mut self, flags: &M2dirFlags) {
        self.0 = self.0.difference(&flags.0).cloned().collect();
    }

    /// Serializes the flag set to its on-disk `.flags` representation:
    /// one flag per line, deterministic alphabetical order.
    pub fn to_meta(&self) -> String {
        let mut out = String::new();
        for flag in &self.0 {
            out.push_str(flag);
            out.push('\n');
        }
        out
    }

    /// Parses a `.flags` metadata payload (one flag per line, blanks
    /// ignored).
    pub fn from_meta(contents: &str) -> Self {
        Self(
            contents
                .lines()
                .filter(|line| !line.is_empty())
                .map(ToString::to_string)
                .collect(),
        )
    }
}

impl fmt::Display for M2dirFlags {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let sorted: Vec<&str> = self.0.iter().map(String::as_str).collect();
        write!(f, "{}", sorted.join(","))
    }
}

impl FromIterator<String> for M2dirFlags {
    fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self {
        Self(iter.into_iter().collect())
    }
}

impl<'a> FromIterator<&'a str> for M2dirFlags {
    fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self {
        Self(iter.into_iter().map(ToString::to_string).collect())
    }
}

impl From<BTreeSet<String>> for M2dirFlags {
    fn from(set: BTreeSet<String>) -> Self {
        Self(set)
    }
}

impl From<M2dirFlags> for BTreeSet<String> {
    fn from(flags: M2dirFlags) -> Self {
        flags.0
    }
}

#[cfg(test)]
mod tests {
    use crate::flag::types::*;

    #[test]
    fn meta_round_trip() {
        let mut flags = M2dirFlags::default();
        flags.insert("$seen");
        flags.insert("$forwarded");
        flags.insert("custom");

        let serialized = flags.to_meta();
        let parsed = M2dirFlags::from_meta(&serialized);

        assert_eq!(parsed.len(), 3);
        assert!(parsed.contains("$seen"));
        assert!(parsed.contains("$forwarded"));
        assert!(parsed.contains("custom"));
    }

    #[test]
    fn meta_is_sorted() {
        let mut flags = M2dirFlags::default();
        flags.insert("zeta");
        flags.insert("alpha");
        flags.insert("middle");
        assert_eq!(flags.to_meta(), "alpha\nmiddle\nzeta\n");
    }

    #[test]
    fn from_meta_ignores_blanks() {
        let parsed = M2dirFlags::from_meta("$seen\n\n\n$forwarded\n");
        assert_eq!(parsed.len(), 2);
        assert!(parsed.contains("$seen"));
        assert!(parsed.contains("$forwarded"));
    }
}