Struct FeedRef

pub struct FeedRef<'a> { /* private fields */ }

A Feed implemented with a borrowed reference to a JSON object.

Implementations

impl<'a> FeedRef<'a>

pub fn as_map(&self) -> &Map<String, Value>

Returns the inner Map as a reference.

impl<'a> FeedRef<'a>

pub fn to_feed(&self) -> Feed

Clones the inner Map reference and returns an owned type.

pub fn version(&self) -> Result<Option<&str>, Error>

The required URL formatted version identifier.

Identifies what version of the spec the feed is suppose to be compliant with.

pub fn title(&self) -> Result<Option<&str>, Error>

The optional name of the feed.

pub fn home_page_url(&self) -> Result<Option<&str>, Error>

The optional URL which the feed is suppose to represent.

pub fn feed_url(&self) -> Result<Option<&str>, Error>

The optional URL which this feed can be retrieived from.

pub fn description(&self) -> Result<Option<&str>, Error>

An optional description of the feed.

pub fn user_comment(&self) -> Result<Option<&str>, Error>

An optional meta description about the feed only intended to be viewed in the raw JSON form.

pub fn next_url(&self) -> Result<Option<&str>, Error>

An optional pagination URL.

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

An optional URL to an icon for use in a list of items.

pub fn favicon(&self) -> Result<Option<&str>, Error>

An optional URL to a favicon suitable for use in a list of feeds.

pub fn author(&self) -> Result<Option<AuthorRef<'_>>, Error>

An optional author.

Deprecation

The author field is deprecated in favor of the authors field as of JSON Feed 1.1.

pub fn authors(&self) -> Result<Option<Vec<AuthorRef<'_>>>, Error>

An optional array of authors.

pub fn language(&self) -> Result<Option<&str>, Error>

The optional language which the feed data is written in.

Valid values are from RFC 5646.

pub fn expired(&self) -> Result<Option<bool>, Error>

Optionally determines if the feed will be updated in the future.

If true, the feed will not be updated in the future. If false or None, then the feed may be updated in the future.

pub fn hubs(&self) -> Result<Option<Vec<HubRef<'_>>>, Error>

Optional subscription endpoints which can be used to received feed update notifications.

pub fn items(&self) -> Result<Option<Vec<ItemRef<'_>>>, Error>

A required array of Items.

impl FeedRef<'_>

pub fn is_valid(&self, version: &Version<'_>) -> bool

Verifies if the JSON data complies with a specific Version of the JSON Feed spec.

Trait Implementations

impl<'a> AsRef<Map<String, Value>> for FeedRef<'a>

fn as_ref(&self) -> &Map<String, Value>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for FeedRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Map<String, Value>> for FeedRef<'a>

fn from(value: &'a Map<String, Value>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut Map<String, Value>> for FeedRef<'a>

fn from(value: &'a mut Map<String, Value>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<Map<String, Value>> for FeedRef<'a>

fn eq(&self, other: &Map<String, Value>) -> 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<'a> PartialEq for FeedRef<'a>

fn eq(&self, other: &FeedRef<'_>) -> 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<'a> Serialize for FeedRef<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for FeedRef<'a>