Struct Image

pub struct Image {
    pub url: String,
    pub title: String,
    pub link: String,
    pub width: Option<String>,
    pub height: Option<String>,
    pub description: Option<String>,
}

Represents an image in an RSS feed.

Fields

url: String

The URL of the image.

title: String

A description of the image. This is used in the HTML alt attribute.

link: String

The URL that the image links to.

width: Option<String>

The width of the image.

height: Option<String>

The height of the image.

description: Option<String>

The text for the HTML title attribute of the link formed around the image.

Implementations

impl Image

pub fn url(&self) -> &str

Return the URL of this image.

Examples

use rss::Image;

let mut image = Image::default();
image.set_url("http://example.com/image.png");
assert_eq!(image.url(), "http://example.com/image.png");

pub fn set_url<V>(&mut self, url: V)

where V: Into<String>,

Set the URL of this image.

Examples

use rss::Image;

let mut image = Image::default();
image.set_url("http://example.com/image.png");

pub fn title(&self) -> &str

Return the description of this image.

This is used in the HTML alt attribute.

Examples

use rss::Image;

let mut image = Image::default();
image.set_title("Example image");
assert_eq!(image.title(), "Example image");

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

where V: Into<String>,

Set the description of this image.

This is used in the HTML alt attribute.

Examples

use rss::Image;

let mut image = Image::default();
image.set_title("Example image");

pub fn link(&self) -> &str

Return the URL that this image links to.

Examples

use rss::Image;

let mut image = Image::default();
image.set_link("http://example.com");
assert_eq!(image.link(), "http://example.com");

pub fn set_link<V>(&mut self, link: V)

where V: Into<String>,

Set the URL that this image links to.

Examples

use rss::Image;

let mut image = Image::default();
image.set_link("http://example.com");

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

Return the width of this image.

If the width is None the default value should be considered to be 80.

Examples

use rss::Image;

let mut image = Image::default();
image.set_width("80".to_string());
assert_eq!(image.width(), Some("80"));

pub fn set_width<V>(&mut self, width: V)

where V: Into<Option<String>>,

Set the width of this image.

Examples

use rss::Image;

let mut image = Image::default();
image.set_width("80".to_string());

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

Return the height of this image.

If the height is None the default value should be considered to be 31.

Examples

use rss::Image;

let mut image = Image::default();
image.set_height("31".to_string());
assert_eq!(image.height(), Some("31"));

pub fn set_height<V>(&mut self, height: V)

where V: Into<Option<String>>,

Set the height of this image.

If the height is None the default value should be considered to be 31.

Examples

use rss::Image;

let mut image = Image::default();
image.set_height("31".to_string());

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

Return the title for the link formed around this image.

Examples

use rss::Image;

let mut image = Image::default();
image.set_description("Example Title".to_string());
assert_eq!(image.description(), Some("Example Title"));

pub fn set_description<V>(&mut self, description: V)

where V: Into<Option<String>>,

Set the title for the link formed around this image.

Examples

use rss::Image;

let mut image = Image::default();
image.set_description("Example Title".to_string());

impl Image

pub fn from_xml<R: BufRead>( reader: &mut Reader<R>, _: Attributes<'_>, ) -> Result<Self, Error>

Builds an Image from source XML

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Default for Image

fn default() -> Image

Returns the “default value” for a type.

impl PartialEq for Image

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