1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
// This file is part of rss.
//
// Copyright © 2015-2021 The rust-syndication Developers
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the MIT License and/or Apache 2.0 License.
use std::io::{BufRead, Write};
use quick_xml::events::attributes::Attributes;
use quick_xml::events::{BytesEnd, BytesStart, BytesText, Event};
use quick_xml::Error as XmlError;
use quick_xml::Reader;
use quick_xml::Writer;
use crate::error::Error;
use crate::toxml::ToXml;
use crate::util::{decode, element_text};
/// Represents the GUID of an RSS item.
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, 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 Guid {
/// The value of the GUID.
pub value: String,
/// Indicates if the GUID is a permalink.
pub permalink: bool,
}
impl Guid {
/// Return whether this GUID is a permalink.
///
/// # Examples
///
/// ```
/// use rss::Guid;
///
/// let mut guid = Guid::default();
/// guid.set_permalink(true);
/// assert!(guid.is_permalink());
/// ```
pub fn is_permalink(&self) -> bool {
self.permalink
}
/// Set whether this GUID is a permalink.
///
/// # Examples
///
/// ```
/// use rss::Guid;
///
/// let mut guid = Guid::default();
/// guid.set_permalink(true);
/// ```
pub fn set_permalink<V>(&mut self, permalink: V)
where
V: Into<bool>,
{
self.permalink = permalink.into()
}
/// Return the value of this GUID.
///
/// # Examples
///
/// ```
/// use rss::Guid;
///
/// let mut guid = Guid::default();
/// guid.set_value("00000000-0000-0000-0000-00000000000");
/// assert_eq!(guid.value(), "00000000-0000-0000-0000-00000000000");
/// ```
pub fn value(&self) -> &str {
self.value.as_str()
}
/// Set the value of this GUID.
///
/// # Examples
///
/// ```
/// use rss::Guid;
///
/// let mut guid = Guid::default();
/// guid.set_value("00000000-0000-0000-0000-00000000000");
/// ```
pub fn set_value<V>(&mut self, value: V)
where
V: Into<String>,
{
self.value = value.into();
}
}
impl Default for Guid {
#[inline]
fn default() -> Self {
Guid {
value: Default::default(),
permalink: true,
}
}
}
impl Guid {
/// Builds a Guid from source XML
pub fn from_xml<R: BufRead>(
reader: &mut Reader<R>,
mut atts: Attributes,
) -> Result<Self, Error> {
let mut guid = Guid::default();
for attr in atts.with_checks(false).flatten() {
if decode(attr.key.as_ref(), reader)?.as_ref() == "isPermaLink" {
guid.permalink = &*attr.value != b"false";
break;
}
}
guid.value = element_text(reader)?.unwrap_or_default();
Ok(guid)
}
}
impl ToXml for Guid {
fn to_xml<W: Write>(&self, writer: &mut Writer<W>) -> Result<(), XmlError> {
let name = "guid";
let mut element = BytesStart::new(name);
if !self.permalink {
element.push_attribute(("isPermaLink", "false"));
}
writer.write_event(Event::Start(element))?;
writer.write_event(Event::Text(BytesText::new(&self.value)))?;
writer.write_event(Event::End(BytesEnd::new(name)))?;
Ok(())
}
}
#[cfg(feature = "builders")]
impl GuidBuilder {
/// Builds a new `Guid`.
pub fn build(&self) -> Guid {
self.build_impl().unwrap()
}
}