use std::borrow::Cow;
use std::io::{BufRead, Write};
use quick_xml::events::{BytesStart, Event};
use quick_xml::Reader;
use quick_xml::Writer;
use crate::error::{Error, XmlError};
use crate::toxml::ToXml;
use crate::util::{attr_value, decode};
/// Represents a category in an Atom feed
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[derive(Debug, Default, Clone, PartialEq)]
#[cfg_attr(feature = "builders", derive(Builder))]
#[cfg_attr(
feature = "builders",
builder(
setter(into),
default,
build_fn(name = "build_impl", private, error = "never::Never")
)
)]
pub struct Category {
/// Identifies the category.
pub term: String,
/// Identifies the categorization scheme via a URI.
pub scheme: Option<String>,
/// A human-readable label for display.
pub label: Option<String>,
}
impl Category {
/// Return the term that identifies this category.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_term("technology");
/// assert_eq!(category.term(), "technology");
/// ```
pub fn term(&self) -> &str {
self.term.as_str()
}
/// Set the term that identifies this category.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_term("technology");
/// ```
pub fn set_term<V>(&mut self, term: V)
where
V: Into<String>,
{
self.term = term.into();
}
/// Return the categorization scheme URI.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_scheme("http://example.com/scheme".to_string());
/// assert_eq!(category.scheme(), Some("http://example.com/scheme"));
/// ```
pub fn scheme(&self) -> Option<&str> {
self.scheme.as_deref()
}
/// Set the categorization scheme URI.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_scheme("http://example.com/scheme".to_string());
/// ```
pub fn set_scheme<V>(&mut self, scheme: V)
where
V: Into<Option<String>>,
{
self.scheme = scheme.into();
}
/// Return the label for this category.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_scheme("Technology".to_string());
/// assert_eq!(category.scheme(), Some("Technology"));
/// ```
pub fn label(&self) -> Option<&str> {
self.label.as_deref()
}
/// Set the label for this category.
///
/// # Examples
///
/// ```
/// use atom_syndication::Category;
///
/// let mut category = Category::default();
/// category.set_scheme("Technology".to_string());
/// ```
pub fn set_label<V>(&mut self, label: V)
where
V: Into<Option<String>>,
{
self.label = label.into();
}
}
impl Category {
pub(crate) fn from_xml<'s, B: BufRead>(
reader: &mut Reader<B>,
element: &'s BytesStart<'s>,
) -> Result<Self, Error> {
let mut category = Category::default();
for att in element.attributes().with_checks(false).flatten() {
match decode(att.key.as_ref(), reader)? {
Cow::Borrowed("term") => {
category.term = attr_value(&att, reader)?.to_string();
}
Cow::Borrowed("scheme") => {
category.scheme = Some(attr_value(&att, reader)?.to_string());
}
Cow::Borrowed("label") => {
category.label = Some(attr_value(&att, reader)?.to_string());
}
_ => {}
}
}
Ok(category)
}
}
impl ToXml for Category {
fn to_xml<W: Write>(&self, writer: &mut Writer<W>) -> Result<(), XmlError> {
let mut element = BytesStart::new("category");
element.push_attribute(("term", &*self.term));
if let Some(ref scheme) = self.scheme {
element.push_attribute(("scheme", &**scheme));
}
if let Some(ref label) = self.label {
element.push_attribute(("label", &**label));
}
writer
.write_event(Event::Empty(element))
.map_err(XmlError::new)?;
Ok(())
}
}
#[cfg(feature = "builders")]
impl CategoryBuilder {
/// Builds a new `Category`.
pub fn build(&self) -> Category {
self.build_impl().unwrap()
}
}