use std::borrow::Cow;
use std::io::{BufRead, Write};
use quick_xml::events::attributes::Attributes;
use quick_xml::events::{BytesEnd, BytesStart, BytesText, Event};
use quick_xml::Reader;
use quick_xml::Writer;
use crate::error::{Error, XmlError};
use crate::fromxml::FromXml;
use crate::toxml::ToXml;
use crate::util::{atom_text, attr_value, decode};
/// Represents the generator of 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 Generator {
/// The name of the generator.
pub value: String,
/// The generator URI.
pub uri: Option<String>,
/// The generator version.
pub version: Option<String>,
}
impl Generator {
/// Return the name of the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_value("Feed Generator");
/// assert_eq!(generator.value(), "Feed Generator");
/// ```
pub fn value(&self) -> &str {
self.value.as_str()
}
/// Set the name of the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_value("Feed Generator");
/// assert_eq!(generator.value(), "Feed Generator");
/// ```
pub fn set_value<V>(&mut self, value: V)
where
V: Into<String>,
{
self.value = value.into()
}
/// Return the URI for the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_uri("http://example.com/generator".to_string());
/// assert_eq!(generator.uri(), Some("http://example.com/generator"));
/// ```
pub fn uri(&self) -> Option<&str> {
self.uri.as_deref()
}
/// Set the URI for the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_uri("http://example.com/generator".to_string());
/// ```
pub fn set_uri<V>(&mut self, uri: V)
where
V: Into<Option<String>>,
{
self.uri = uri.into()
}
/// Return the version of the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_version("1.0".to_string());
/// assert_eq!(generator.version(), Some("1.0"));
/// ```
pub fn version(&self) -> Option<&str> {
self.version.as_deref()
}
/// Set the version of the generator.
///
/// # Examples
///
/// ```
/// use atom_syndication::Generator;
///
/// let mut generator = Generator::default();
/// generator.set_version("1.0".to_string());
/// ```
pub fn set_version<V>(&mut self, version: V)
where
V: Into<Option<String>>,
{
self.version = version.into()
}
}
impl FromXml for Generator {
fn from_xml<B: BufRead>(
reader: &mut Reader<B>,
mut atts: Attributes<'_>,
) -> Result<Self, Error> {
let mut generator = Generator::default();
for att in atts.with_checks(false).flatten() {
match decode(att.key.as_ref(), reader)? {
Cow::Borrowed("uri") => {
generator.uri = Some(attr_value(&att, reader)?.to_string());
}
Cow::Borrowed("version") => {
generator.version = Some(attr_value(&att, reader)?.to_string());
}
_ => {}
}
}
generator.value = atom_text(reader)?.unwrap_or_default();
Ok(generator)
}
}
impl ToXml for Generator {
fn to_xml<W: Write>(&self, writer: &mut Writer<W>) -> Result<(), XmlError> {
let name = "generator";
let mut element = BytesStart::new(name);
if let Some(ref uri) = self.uri {
element.push_attribute(("uri", &**uri));
}
if let Some(ref version) = self.version {
element.push_attribute(("version", &**version));
}
writer
.write_event(Event::Start(element))
.map_err(XmlError::new)?;
writer
.write_event(Event::Text(BytesText::new(&self.value)))
.map_err(XmlError::new)?;
writer
.write_event(Event::End(BytesEnd::new(name)))
.map_err(XmlError::new)?;
Ok(())
}
}
#[cfg(feature = "builders")]
impl GeneratorBuilder {
/// Builds a new `Generator`.
pub fn build(&self) -> Generator {
self.build_impl().unwrap()
}
}