Struct rss::extension::itunes::ITunesItemExtension

pub struct ITunesItemExtension {

    pub author: Option<String>,
    pub block: Option<String>,
    pub image: Option<String>,
    pub duration: Option<String>,
    pub explicit: Option<String>,
    pub closed_captioned: Option<String>,
    pub order: Option<String>,
    pub subtitle: Option<String>,
    pub summary: Option<String>,
    pub keywords: Option<String>,
    pub episode: Option<String>,
    pub season: Option<String>,
    pub episode_type: Option<String>,
}

An iTunes item element extension.

Fields

author: Option<String>

The author of the podcast episode.

block: Option<String>

Specifies if the podcast episode should be prevented from appearing in the iTunes Store. A value of Yes indicates that the episode should not show up in the iTunes Store. All other values are ignored.

image: Option<String>

The artwork for the podcast episode.

duration: Option<String>

The podcast episode duration in one of the following formats: HH:MM:SS, H:MM:SS, MM:SS, M:SS.

explicit: Option<String>

Specifies whether the podcast episode contains explicit content. A value of Yes, Explicit, or True indicates that the episode contains explicit content. A value of Clean, No, False indicates that episode does not contain explicit content.

closed_captioned: Option<String>

Specifies whether the podcast episode contains embedded closed captioning. A value of Yes indicates that it does. Any other value indicates that it does not.

order: Option<String>

A value used to override the default sorting order for episodes.

subtitle: Option<String>

A description of the podcast episode.

summary: Option<String>

A summary of the podcast episode.

keywords: Option<String>

Keywords for the podcast. The string contains a comma separated list of keywords.

episode: Option<String>

Episode number for this episode.

season: Option<String>

Season number for this episode.

episode_type: Option<String>

Type of episode. Usually full, but potentially also trailer or bonus

Implementations

impl ITunesItemExtension

pub fn author(&self) -> Option<&str>

Return the author of this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_author("John Doe".to_string());
assert_eq!(extension.author(), Some("John Doe"));

pub fn set_author<V>(&mut self, author: V)

where V: Into<Option<String>>,

Set the author of this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_author("John Doe".to_string());

pub fn block(&self) -> Option<&str>

Return whether this podcast episode should be blocked from appearing in the iTunes Store.

A value of Yes indicates that the podcast should not show up in the iTunes Store. All other values are ignored.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_block("Yes".to_string());
assert_eq!(extension.block(), Some("Yes"));

pub fn set_block<V>(&mut self, block: V)

where V: Into<Option<String>>,

Set whether this podcast episode should be blocked from appearing in the iTunes Store.

A value of Yes indicates that the podcast should not show up in the iTunes Store. All other values are ignored.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_block("Yes".to_string());

pub fn image(&self) -> Option<&str>

Return the artwork URL for this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_image("http://example.com/artwork.png".to_string());
assert_eq!(extension.image(), Some("http://example.com/artwork.png"));

pub fn set_image<V>(&mut self, image: V)

where V: Into<Option<String>>,

Set the artwork URL for this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_image("http://example.com/artwork.png".to_string());

pub fn duration(&self) -> Option<&str>

Return the duration of this podcast episode.

The duration should be in one of the following formats: HH:MM:SS, H:MM:SS, MM:SS, M:SS.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_duration("1:00".to_string());
assert_eq!(extension.duration(), Some("1:00"));

pub fn set_duration<V>(&mut self, duration: V)

where V: Into<Option<String>>,

Set the duration of this podcast episode.

The duration should be in one of the following formats: HH:MM:SS, H:MM:SS, MM:SS, M:SS.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_duration("1:00".to_string());

pub fn explicit(&self) -> Option<&str>

Return whether this podcast episode contains explicit content.

A value of Yes, Explicit, or True indicates that the episode contains explicit content. A value of Clean, No, False indicates that episode does not contain explicit content.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_explicit("Yes".to_string());
assert_eq!(extension.explicit(), Some("Yes"));

pub fn set_explicit<V>(&mut self, explicit: V)

where V: Into<Option<String>>,

Set whether this podcast episode contains explicit content.

A value of Yes, Explicit, or True indicates that the episode contains explicit content. A value of Clean, No, False indicates that episode does not contain explicit content.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_explicit("Yes".to_string());

pub fn closed_captioned(&self) -> Option<&str>

Return whether this podcast episode contains embedded closed captioning.

A value of Yes indicates that it does. Any other value indicates that it does not.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_closed_captioned("Yes".to_string());
assert_eq!(extension.closed_captioned(), Some("Yes"));

pub fn set_closed_captioned<V>(&mut self, closed_captioned: V)

where V: Into<Option<String>>,

Set whether this podcast episode contains embedded closed captioning.

A value of Yes indicates that it does. Any other value indicates that it does not.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_closed_captioned("Yes".to_string());

pub fn order(&self) -> Option<&str>

Return the value used to override the default sorting order for episodes.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_order("1".to_string());
assert_eq!(extension.order(), Some("1"));

pub fn set_order<V>(&mut self, order: V)

where V: Into<Option<String>>,

Set the value used to override the default sorting order for episodes.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_order("1".to_string());

pub fn subtitle(&self) -> Option<&str>

Return the description of this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_subtitle("An episode".to_string());
assert_eq!(extension.subtitle(), Some("An episode"));

pub fn set_subtitle<V>(&mut self, subtitle: V)

where V: Into<Option<String>>,

Set the description of this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_subtitle("An episode".to_string());

pub fn summary(&self) -> Option<&str>

Return the summary for this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_summary("An episode".to_string());
assert_eq!(extension.summary(), Some("An episode"));

pub fn set_summary<V>(&mut self, summary: V)

where V: Into<Option<String>>,

Set the summary for this podcast episode.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_summary("An episode".to_string());

pub fn keywords(&self) -> Option<&str>

Return the keywords for this podcast episode.

A comma separated list of keywords.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_keywords("technology".to_string());
assert_eq!(extension.keywords(), Some("technology"));

pub fn set_keywords<V>(&mut self, keywords: V)

where V: Into<Option<String>>,

Set the keywords for this podcast episode.

A comma separated list of keywords.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_keywords("technology".to_string());

pub fn episode(&self) -> Option<&str>

Return the episode number of this podcast episode

The episode number will be a string although it is typically a number in practice

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_episode("3".to_string());
assert_eq!(extension.episode(), Some("3"));

pub fn set_episode<V>(&mut self, episode: V)

where V: Into<Option<String>>,

Set the the episode number for this episode.

An string.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_episode("2".to_string());
assert_eq!(extension.episode(), Some("2"));

pub fn season(&self) -> Option<&str>

Return the season of this podcast episode

The season will be a string although it is typically a number in practice

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_season("3".to_string());
assert_eq!(extension.season(), Some("3"));

pub fn set_season<V>(&mut self, season: V)

where V: Into<Option<String>>,

Set the the season number for this episode.

An integer.

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_season("3".to_string());
assert_eq!(extension.season(), Some("3"));

pub fn episode_type(&self) -> Option<&str>

Return the episode_type of this podcast episode

The episode type will be a string usually “full” “trailer” or “bonus”

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_episode_type("trailer".to_string());
assert_eq!(extension.episode_type(), Some("trailer"));

pub fn set_episode_type<V>(&mut self, episode_type: V)

where V: Into<Option<String>>,

Set the the episode type for this episode.

A string, usually “full” but maybe “trailer” or “bonus”

Examples

use rss::extension::itunes::ITunesItemExtension;

let mut extension = ITunesItemExtension::default();
extension.set_episode_type("full".to_string());
assert_eq!(extension.episode_type(), Some("full"));

impl ITunesItemExtension

pub fn from_map(map: BTreeMap<String, Vec<Extension>>) -> Self

Create an ITunesChannelExtension from a BTreeMap.

Trait Implementations

impl Clone for ITunesItemExtension

fn clone(&self) -> ITunesItemExtension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ITunesItemExtension

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

Formats the value using the given formatter.

impl Default for ITunesItemExtension

fn default() -> ITunesItemExtension

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ITunesItemExtension

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ITunesItemExtension

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ITunesItemExtension

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 ITunesItemExtension