Struct AtomFeed 

#[non_exhaustive]
pub struct AtomFeed {

    pub id: String,
    pub title: String,
    pub subtitle: String,
    pub updated: String,
    pub rights: String,
    pub generator: String,
    pub icon: String,
    pub logo: String,
    pub language: String,
    pub authors: Vec<AtomPerson>,
    pub contributors: Vec<AtomPerson>,
    pub links: Vec<AtomLink>,
    pub categories: Vec<String>,
    pub entries: Vec<AtomEntry>,
}

An Atom 1.0 feed (<feed>) document.

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.

id: String

Permanent, universally unique identifier of the feed (RFC 4287 §4.2.6).

title: String

Human-readable title of the feed.

subtitle: String

Optional human-readable subtitle.

updated: String

RFC 3339 timestamp of the most recent significant modification.

rights: String

Optional rights / copyright string.

generator: String

Generator identification (e.g. "rss-gen").

icon: String

Optional URI of a small icon representing the feed.

logo: String

Optional URI of a larger logo representing the feed.

language: String

Language tag (e.g. "en-US"). Emitted as xml:lang on <feed>.

authors: Vec<AtomPerson>

Authors of the feed.

contributors: Vec<AtomPerson>

Contributors to the feed.

links: Vec<AtomLink>

Links advertised at feed level (self, alternate, …).

categories: Vec<String>

Category tags applied to the feed (term values only).

entries: Vec<AtomEntry>

Entries contained in the feed.

Implementations

impl AtomFeed

pub fn new() -> Self

Creates an empty AtomFeed.

pub fn id<S: Into<String>>(self, value: S) -> Self

Sets the feed’s permanent identifier.

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

Sets the feed title.

pub fn subtitle<S: Into<String>>(self, value: S) -> Self

Sets the feed subtitle.

pub fn updated<S: Into<String>>(self, value: S) -> Self

Sets the feed-level updated timestamp (RFC 3339).

pub fn rights<S: Into<String>>(self, value: S) -> Self

Sets the rights string.

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

Sets the generator string.

pub fn icon<S: Into<String>>(self, value: S) -> Self

Sets the icon URI.

pub fn logo<S: Into<String>>(self, value: S) -> Self

Sets the logo URI.

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

Sets the xml:lang value.

pub fn author_name<S: Into<String>>(self, name: S) -> Self

Adds an author with the given name.

pub fn add_author(self, author: AtomPerson) -> Self

Adds an AtomPerson to the author list.

pub fn add_contributor(self, contributor: AtomPerson) -> Self

Adds an AtomPerson to the contributor list.

pub fn add_link(self, link: AtomLink) -> Self

Adds an AtomLink to the feed.

pub fn self_link<S: Into<String>>(self, href: S) -> Self

Convenience: adds a rel="self" link to the canonical feed URL.

pub fn alternate_link<S: Into<String>>(self, href: S) -> Self

Convenience: adds a rel="alternate" link to the human page.

pub fn add_category<S: Into<String>>(self, term: S) -> Self

Adds a category tag.

pub fn add_entry(self, entry: AtomEntry) -> Self

Appends an entry to the feed.

pub fn entry_count(&self) -> usize

Number of entries in the feed.

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

Validates the feed against the required RFC 4287 elements.

Error messages are prefixed with feed. for top-level violations and entry.<idx>. for per-entry violations, matching the contextual validation introduced in issue #34 for the RSS code path.

Errors

Returns RssError::ValidationErrors containing every missing or invalid required element discovered.

Trait Implementations

impl Clone for AtomFeed

fn clone(&self) -> AtomFeed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtomFeed

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

Formats the value using the given formatter.

impl Default for AtomFeed

fn default() -> AtomFeed

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AtomFeed

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AtomFeed

fn eq(&self, other: &AtomFeed) -> 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 AtomFeed

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AtomFeed