feed 2.1.0

Deprecated. This project has been merged with the rss crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

// This file is part of feed.
//
// Copyright © 2015-2017 Chris Palmer <pennstate5013@gmail.com>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.


//! The fields under category can be retrieved by using the methods under
//! `Category`.

use CategoryGetters;
use rss::Category;

impl CategoryGetters for Category
{
    /// Get the category that exists under `Category`.
    ///
    /// # Examples
    ///
    /// ```
    /// use feed::{CategoryBuilder, CategoryGetters};
    ///
    /// let category = "podcast";
    ///
    /// let category_obj = CategoryBuilder::new()
    ///     .name(category)
    ///     .finalize()
    ///     .unwrap();
    ///
    /// assert_eq!(category.to_owned(), category_obj.name());
    /// ```
    fn name(&self) -> String
    {
        self.name.clone()
    }


    /// Get the optional domain that exists under `Category`.
    ///
    /// # Examples
    ///
    /// ```
    /// use feed::{CategoryBuilder, CategoryGetters};
    ///
    /// let domain_string = "http://jupiterbroadcasting.com/".to_owned();
    ///
    /// let category = CategoryBuilder::new()
    ///     .domain(Some(domain_string.clone()))
    ///     .finalize()
    ///     .unwrap();
    ///
    /// let domain_option = category.domain();
    /// assert!(domain_option.is_some());
    ///
    /// assert_eq!(domain_string.clone(), domain_option.unwrap());
    /// ```
    ///
    /// ```
    /// use feed::{CategoryBuilder, CategoryGetters};
    ///
    /// let category = CategoryBuilder::new()
    ///     .domain(None)
    ///     .finalize()
    ///     .unwrap();
    ///
    /// let domain_option = category.domain();
    /// assert!(domain_option.is_none());
    /// ```
    fn domain(&self) -> Option<String>
    {
        self.domain.clone()
    }
}