Struct RssData

#[non_exhaustive]
pub struct RssData {

    pub atom_link: String,
    pub author: String,
    pub category: String,
    pub copyright: String,
    pub description: String,
    pub docs: String,
    pub generator: String,
    pub guid: String,
    pub image: String,
    pub language: String,
    pub last_build_date: String,
    pub link: String,
    pub managing_editor: String,
    pub pub_date: String,
    pub title: String,
    pub ttl: String,
    pub webmaster: String,
    pub items: Vec<RssItem>,
    pub version: RssVersion,
}

Represents the main structure for an RSS feed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

atom_link: String

The Atom link of the RSS feed.

author: String

The author of the RSS feed.

category: String

The category of the RSS feed.

copyright: String

The copyright notice for the content of the feed.

description: String

The description of the RSS feed.

docs: String

The docs link of the RSS feed.

generator: String

The generator of the RSS feed.

guid: String

The GUID of the RSS feed.

image: String

The image URL of the RSS feed.

language: String

The language of the RSS feed.

last_build_date: String

The last build date of the RSS feed.

link: String

The main link to the RSS feed.

managing_editor: String

The managing editor of the RSS feed.

pub_date: String

The publication date of the RSS feed.

title: String

The title of the RSS feed.

ttl: String

Time To Live (TTL), the number of minutes the feed should be cached before refreshing.

webmaster: String

The webmaster of the RSS feed.

items: Vec<RssItem>

A collection of additional items in the RSS feed.

version: RssVersion

The version of the RSS feed.

Implementations

impl RssData

pub fn new(version: Option<RssVersion>) -> Self

Creates a new RssData instance with default values and a specified RSS version.

Arguments

• version - An optional RssVersion specifying the RSS version for the feed.

Returns

A new RssData instance.

pub fn set<T: Into<String>>(self, key: &str, value: T) -> Self

Sets the value of a specified field and returns the RssData instance for method chaining.

Arguments

• key - The field to set.
• value - The value to assign to the field.

Returns

The updated RssData instance.

pub fn add_item(&mut self, item: RssItem)

Adds an item to the RSS feed.

This method appends the given RssItem to the items vector of the RssData struct.

Arguments

• item - The RssItem to be added to the feed.

pub fn remove_item(&mut self, guid: &str) -> bool

Removes an item from the RSS feed by its GUID.

Arguments

• guid - The GUID of the item to remove.

Returns

true if an item was removed, false otherwise.

pub fn item_count(&self) -> usize

Returns the number of items in the RSS feed.

pub fn clear_items(&mut self)

Clears all items from the RSS feed.

pub fn validate(&self) -> Result<()>

Validates the RssData to ensure that all required fields are set and valid.

Returns

• Ok(()) if the RssData is valid.
• Err(RssError) if any validation errors are found.

pub fn to_hash_map(&self) -> HashMap<String, String>

Converts the RssData into a HashMap<String, String> for easier manipulation.

Returns

A HashMap<String, String> containing the RSS feed data.

pub fn version(self, version: RssVersion) -> Self

Sets the RSS version.

pub fn atom_link<T: Into<String>>(self, value: T) -> Self

Sets the Atom link.

pub fn author<T: Into<String>>(self, value: T) -> Self

Sets the author.

pub fn category<T: Into<String>>(self, value: T) -> Self

Sets the category.

pub fn copyright<T: Into<String>>(self, value: T) -> Self

Sets the copyright.

pub fn description<T: Into<String>>(self, value: T) -> Self

Sets the description.

pub fn docs<T: Into<String>>(self, value: T) -> Self

Sets the docs link.

pub fn generator<T: Into<String>>(self, value: T) -> Self

Sets the generator.

pub fn guid<T: Into<String>>(self, value: T) -> Self

Sets the GUID.

pub fn image<T: Into<String>>(self, value: T) -> Self

Sets the image URL.

pub fn language<T: Into<String>>(self, value: T) -> Self

Sets the language.

pub fn last_build_date<T: Into<String>>(self, value: T) -> Self

Sets the last build date.

pub fn link<T: Into<String>>(self, value: T) -> Self

Sets the main link.

pub fn managing_editor<T: Into<String>>(self, value: T) -> Self

Sets the managing editor.

pub fn pub_date<T: Into<String>>(self, value: T) -> Self

Sets the publication date.

pub fn title<T: Into<String>>(self, value: T) -> Self

Sets the title.

pub fn ttl<T: Into<String>>(self, value: T) -> Self

Sets the TTL (Time To Live).

pub fn webmaster<T: Into<String>>(self, value: T) -> Self

Sets the webmaster.

Trait Implementations

impl Clone for RssData

fn clone(&self) -> RssData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RssData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RssData

fn default() -> RssData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RssData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RssData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RssData

fn eq(&self, other: &RssData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RssData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RssData

impl StructuralPartialEq for RssData