Skip to main content

AtomEntry

Struct AtomEntry 

Source
#[non_exhaustive]
pub struct AtomEntry {
Show 13 fields pub id: String, pub title: String, pub updated: String, pub published: String, pub summary: String, pub summary_type: AtomTextType, pub content: String, pub content_type: AtomTextType, pub rights: String, pub authors: Vec<AtomPerson>, pub contributors: Vec<AtomPerson>, pub links: Vec<AtomLink>, pub categories: Vec<String>,
}
Expand description

An Atom 1.0 entry (<entry>).

Fields (Non-exhaustive)§

This struct is marked as 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 entry.

§title: String

Human-readable title.

§updated: String

RFC 3339 timestamp of the most recent significant modification.

§published: String

Optional RFC 3339 publication timestamp.

§summary: String

Short human-readable description.

§summary_type: AtomTextType

Type of the summary payload.

§content: String

Full content payload (may be empty).

§content_type: AtomTextType

Type of the content payload.

§rights: String

Optional rights string.

§authors: Vec<AtomPerson>

Authors of the entry.

§contributors: Vec<AtomPerson>

Contributors to the entry.

§links: Vec<AtomLink>

Links attached to the entry, including media enclosures.

§categories: Vec<String>

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

Implementations§

Source§

impl AtomEntry

Source

pub fn new() -> Self

Creates an empty AtomEntry.

Source

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

Sets the entry’s permanent identifier.

Source

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

Sets the entry title.

Source

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

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

Source

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

Sets the entry-level published timestamp (RFC 3339).

Source

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

Sets the plain-text summary.

Source

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

Sets the HTML summary payload.

Source

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

Sets the plain-text content payload.

Source

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

Sets the HTML content payload.

Source

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

Sets the rights string.

Source

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

Adds an author with the given name.

Source

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

Adds an AtomPerson to the entry’s author list.

Adds an AtomLink to the entry.

Convenience: adds a rel="alternate" link to the entry’s resource.

Source

pub fn add_enclosure<S, T>(self, href: S, mime_type: T, length: u64) -> Self
where S: Into<String>, T: Into<String>,

Convenience: attaches a media enclosure (RFC 4287 §4.2.7.2).

Source

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

Adds a category tag.

Source

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

Validates the entry against RFC 4287 §4.1.2 required elements.

Error messages are prefixed with entry. (no index).

§Errors

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

Trait Implementations§

Source§

impl Clone for AtomEntry

Source§

fn clone(&self) -> AtomEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AtomEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AtomEntry

Source§

fn default() -> AtomEntry

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AtomEntry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AtomEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for AtomEntry

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AtomEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.