Struct ItemRef

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

An Item implemented with a borrowed reference to a JSON object.

Implementations

impl<'a> ItemRef<'a>

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

Returns the inner Map as a reference.

impl<'a> ItemRef<'a>

pub fn to_item(&self) -> Item

Clones the inner Map reference and returns an owned type.

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

A required unique identifier for an item.

Important

The ID should be unique across all items which have ever appeared in the feed. An item with the same exact ID as another item (even if it is no longer in the current JSON feed items array) are considered the same item.

Version 1.0 Incompatibility

While JSON Feed 1.0 permitted values which could be coerced into JSON strings (e.g. JSON numbers), this model supports only JSON strings. JSON Feed 1.1 strongly suggests to only use strings. In practice, the vast majority of feeds use strings.

If you wish to support non-String IDs, you can directly access the underlying Map with as_map_mut or an equivalent method and read the JSON value.

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

The optional URL which the item represents.

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

An optional related external URL to the item.

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

An optional title for the item.

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

An optional HTML string representing the content.

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

An optional plain text string representing the content.

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

An optional summary of the item.

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

An optional URL of an image representing the item.

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

An optional URL of a banner image representing the item.

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

The date which the item was published in RFC 3339 format.

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

The date which the item was modified in RFC 3339 format.

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 tags(&self) -> Result<Option<Vec<&str>>, Error>

An optional array of plain text tags.

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 attachments(&self) -> Result<Option<Vec<AttachmentRef<'_>>>, Error>

An optional array of relevant resources for the item.

impl ItemRef<'_>

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 ItemRef<'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 ItemRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Map<String, Value>> for ItemRef<'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 ItemRef<'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 ItemRef<'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 ItemRef<'a>

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