Struct atom_syndication::Feed

pub struct Feed {

    pub title: Text,
    pub id: String,
    pub updated: FixedDateTime,
    pub authors: Vec<Person>,
    pub categories: Vec<Category>,
    pub contributors: Vec<Person>,
    pub generator: Option<Generator>,
    pub icon: Option<String>,
    pub links: Vec<Link>,
    pub logo: Option<String>,
    pub rights: Option<Text>,
    pub subtitle: Option<Text>,
    pub entries: Vec<Entry>,
    pub extensions: ExtensionMap,
    pub namespaces: BTreeMap<String, String>,
    pub base: Option<String>,
    pub lang: Option<String>,
}

Represents an Atom feed

Fields

title: Text

A human-readable title for the feed.

id: String

A universally unique and permanent URI.

updated: FixedDateTime

The last time the feed was modified in a significant way.

authors: Vec<Person>

The authors of the feed.

categories: Vec<Category>

The categories that the feed belongs to.

contributors: Vec<Person>

The contributors to the feed.

generator: Option<Generator>

The software used to generate the feed.

icon: Option<String>

A small image which provides visual identification for the feed.

links: Vec<Link>

The Web pages related to the feed.

logo: Option<String>

A larger image which provides visual identification for the feed.

rights: Option<Text>

Information about rights held in and over the feed.

subtitle: Option<Text>

A human-readable description or subtitle for the feed.

entries: Vec<Entry>

The entries contained in the feed.

extensions: ExtensionMap

The extensions for the feed.

namespaces: BTreeMap<String, String>

The namespaces present in the feed tag.

base: Option<String>

Base URL for resolving any relative references found in the element.

lang: Option<String>

Indicates the natural language for the element.

Implementations

impl Feed

pub fn read_from<B: BufRead>(reader: B) -> Result<Feed, Error>

Attempt to read an Atom feed from the reader.

Examples

use std::io::BufReader;
use std::fs::File;
use atom_syndication::Feed;

let file = File::open("example.xml").unwrap();
let feed = Feed::read_from(BufReader::new(file)).unwrap();

pub fn write_to<W: Write>(&self, writer: W) -> Result<W, Error>

Attempt to write this Atom feed to a writer using default WriteConfig.

Examples

use std::io::BufReader;
use std::fs::File;
use atom_syndication::Feed;

let feed = Feed {
    title: "Feed Title".into(),
    id: "Feed ID".into(),
    ..Default::default()
};

let out = feed.write_to(Vec::new())?;
assert_eq!(&out, br#"<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom"><title>Feed Title</title><id>Feed ID</id><updated>1970-01-01T00:00:00+00:00</updated></feed>"#);

pub fn write_with_config<W: Write>( &self, writer: W, write_config: WriteConfig ) -> Result<W, Error>

Attempt to write this Atom feed to a writer.

Examples

use std::io::BufReader;
use std::fs::File;
use atom_syndication::{Feed, WriteConfig};

let feed = Feed {
    title: "Feed Title".into(),
    id: "Feed ID".into(),
    ..Default::default()
};

let mut out = Vec::new();
let config = WriteConfig {
    write_document_declaration: false,
    indent_size: Some(2),
};
feed.write_with_config(&mut out, config)?;
assert_eq!(&out, br#"<feed xmlns="http://www.w3.org/2005/Atom">
  <title>Feed Title</title>
  <id>Feed ID</id>
  <updated>1970-01-01T00:00:00+00:00</updated>
</feed>"#);

pub fn title(&self) -> &Text

Return the title of this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_title("Feed Title");
assert_eq!(feed.title(), "Feed Title");

pub fn set_title<V>(&mut self, title: V)

where V: Into<Text>,

Set the title of this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_title("Feed Title");

pub fn id(&self) -> &str

Return the unique URI of this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_id("urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6");
assert_eq!(feed.id(), "urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6");

pub fn set_id<V>(&mut self, id: V)

where V: Into<String>,

Set the unique URI of this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_id("urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6");

pub fn updated(&self) -> &FixedDateTime

Return the last time that this feed was modified.

Examples

use atom_syndication::Feed;
use atom_syndication::FixedDateTime;
use std::str::FromStr;

let mut feed = Feed::default();
feed.set_updated(FixedDateTime::from_str("2017-06-03T15:15:44-05:00").unwrap());
assert_eq!(feed.updated().to_rfc3339(), "2017-06-03T15:15:44-05:00");

pub fn set_updated<V>(&mut self, updated: V)

where V: Into<FixedDateTime>,

Set the last time that this feed was modified.

Examples

use atom_syndication::Feed;
use atom_syndication::FixedDateTime;
use std::str::FromStr;

let mut feed = Feed::default();
feed.set_updated(FixedDateTime::from_str("2017-06-03T15:15:44-05:00").unwrap());

pub fn authors(&self) -> &[Person]

Return the authors of this feed.

Examples

use atom_syndication::{Feed, Person};

let mut feed = Feed::default();
feed.set_authors(vec![Person::default()]);
assert_eq!(feed.authors().len(), 1);

pub fn set_authors<V>(&mut self, authors: V)

where V: Into<Vec<Person>>,

Set the authors of this feed.

Examples

use atom_syndication::{Feed, Person};

let mut feed = Feed::default();
feed.set_authors(vec![Person::default()]);

pub fn categories(&self) -> &[Category]

Return the categories this feed belongs to.

Examples

use atom_syndication::{Feed, Category};

let mut feed = Feed::default();
feed.set_categories(vec![Category::default()]);
assert_eq!(feed.categories().len(), 1);

pub fn set_categories<V>(&mut self, categories: V)

where V: Into<Vec<Category>>,

Set the categories this feed belongs to.

Examples

use atom_syndication::{Feed, Category};

let mut feed = Feed::default();
feed.set_categories(vec![Category::default()]);

pub fn contributors(&self) -> &[Person]

Return the contributors to this feed.

Examples

use atom_syndication::{Feed, Person};

let mut feed = Feed::default();
feed.set_contributors(vec![Person::default()]);
assert_eq!(feed.contributors().len(), 1);

pub fn set_contributors<V>(&mut self, contributors: V)

where V: Into<Vec<Person>>,

Set the contributors to this feed.

Examples

use atom_syndication::{Feed, Person};

let mut feed = Feed::default();
feed.set_contributors(vec![Person::default()]);

pub fn generator(&self) -> Option<&Generator>

Return the name of the software used to generate this feed.

Examples

use atom_syndication::{Feed, Generator};

let mut feed = Feed::default();
feed.set_generator(Generator::default());
assert!(feed.generator().is_some());

pub fn set_generator<V>(&mut self, generator: V)

where V: Into<Option<Generator>>,

Set the name of the software used to generate this feed.

Examples

use atom_syndication::{Feed, Generator};

let mut feed = Feed::default();
feed.set_generator(Generator::default());

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

Return the icon for this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_icon("http://example.com/icon.png".to_string());
assert_eq!(feed.icon(), Some("http://example.com/icon.png"));

pub fn set_icon<V>(&mut self, icon: V)

where V: Into<Option<String>>,

Set the icon for this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_icon("http://example.com/icon.png".to_string());

pub fn links(&self) -> &[Link]

Return the Web pages related to this feed.

Examples

use atom_syndication::{Feed, Link};

let mut feed = Feed::default();
feed.set_links(vec![Link::default()]);
assert_eq!(feed.links().len(), 1);

pub fn set_links<V>(&mut self, links: V)

where V: Into<Vec<Link>>,

Set the Web pages related to this feed.

Examples

use atom_syndication::{Feed, Link};

let mut feed = Feed::default();
feed.set_links(vec![Link::default()]);

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

Return the logo for this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_logo("http://example.com/logo.png".to_string());
assert_eq!(feed.logo(), Some("http://example.com/logo.png"));

pub fn set_logo<V>(&mut self, logo: V)

where V: Into<Option<String>>,

Set the logo for this feed.

Examples

use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_logo("http://example.com/logo.png".to_string());

pub fn rights(&self) -> Option<&Text>

Return the information about the rights held in and over this feed.

Examples

use atom_syndication::{Feed, Text};

let mut feed = Feed::default();
feed.set_rights(Text::from("© 2017 John Doe"));
assert_eq!(feed.rights().map(Text::as_str), Some("© 2017 John Doe"));

pub fn set_rights<V>(&mut self, rights: V)

where V: Into<Option<Text>>,

Set the information about the rights held in and over this feed.

Examples

use atom_syndication::{Feed, Text};

let mut feed = Feed::default();
feed.set_rights(Text::from("© 2017 John Doe"));

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

Return the description or subtitle of this feed.

Examples

use atom_syndication::{Feed, Text};

let mut feed = Feed::default();
feed.set_subtitle(Text::from("Feed subtitle"));
assert_eq!(feed.subtitle().map(Text::as_str), Some("Feed subtitle"));

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

where V: Into<Option<Text>>,

Set the description or subtitle of this feed.

Examples

use atom_syndication::{Feed, Text};

let mut feed = Feed::default();
feed.set_subtitle(Text::from("Feed subtitle"));

pub fn entries(&self) -> &[Entry]

Return the entries in this feed.

Examples

use atom_syndication::{Feed, Entry};

let mut feed = Feed::default();
feed.set_entries(vec![Entry::default()]);
assert_eq!(feed.entries().len(), 1);

pub fn set_entries<V>(&mut self, entries: V)

where V: Into<Vec<Entry>>,

Set the entries in this feed.

Examples

use atom_syndication::{Feed, Entry};

let mut feed = Feed::default();
feed.set_entries(vec![Entry::default()]);

pub fn extensions(&self) -> &ExtensionMap

Return the extensions for this feed.

Examples

use std::collections::BTreeMap;
use atom_syndication::Feed;
use atom_syndication::extension::{ExtensionMap, Extension};

let extension = Extension::default();

let mut item_map = BTreeMap::<String, Vec<Extension>>::new();
item_map.insert("ext:name".to_string(), vec![extension]);

let mut extension_map = ExtensionMap::default();
extension_map.insert("ext".to_string(), item_map);

let mut feed = Feed::default();
feed.set_extensions(extension_map);
assert_eq!(feed.extensions()
               .get("ext")
               .and_then(|m| m.get("ext:name"))
               .map(|v| v.len()),
           Some(1));

pub fn set_extensions<V>(&mut self, extensions: V)

where V: Into<ExtensionMap>,

Set the extensions for this feed.

Examples

use atom_syndication::Feed;
use atom_syndication::extension::ExtensionMap;

let mut feed = Feed::default();
feed.set_extensions(ExtensionMap::default());

pub fn namespaces(&self) -> &BTreeMap<String, String>

Return the namespaces for this feed.

Examples

use std::collections::BTreeMap;
use atom_syndication::Feed;

let mut namespaces = BTreeMap::new();
namespaces.insert("ext".to_string(), "http://example.com".to_string());

let mut feed = Feed::default();
feed.set_namespaces(namespaces);
assert_eq!(feed.namespaces().get("ext").map(|s| s.as_str()), Some("http://example.com"));

pub fn set_namespaces<V>(&mut self, namespaces: V)

where V: Into<BTreeMap<String, String>>,

Set the namespaces for this feed.

Examples

use std::collections::BTreeMap;
use atom_syndication::Feed;

let mut feed = Feed::default();
feed.set_namespaces(BTreeMap::new());

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

Return base URL of the feed.

pub fn set_base<V>(&mut self, base: V)

where V: Into<Option<String>>,

Set base URL of the feed.

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

Return natural language of the feed.

pub fn set_lang<V>(&mut self, lang: V)

where V: Into<Option<String>>,

Set the base URL of the feed.

Trait Implementations

impl Clone for Feed

fn clone(&self) -> Feed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Feed

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

Formats the value using the given formatter.

impl Default for Feed

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for Feed

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl PartialEq for Feed

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

fn to_string(&self) -> String

Converts the given value to a String.

impl StructuralPartialEq for Feed