Struct Attachment

pub struct Attachment { /* private fields */ }

A relevant resource for an Item.

Valid Attachment

An Attachment must have both the url and mime_type properties set.

Implementations

impl Attachment

pub fn new() -> Self

Instantiates with an empty JSON object.

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

Returns the inner Map as a reference.

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

Returns the inner Map as a mutable reference.

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

Converts the type into the inner Map.

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

The required URL for the attachment.

pub fn set_url<T>(&mut self, value: T) -> Option<Value>

where T: ToString,

Sets the URL.

pub fn remove_url(&mut self) -> Option<Value>

Removes the URL.

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

The required MIME type (e.g. image/png).

pub fn set_mime_type<T>(&mut self, value: T) -> Option<Value>

where T: ToString,

Sets the MIME type.

pub fn remove_mime_type(&mut self) -> Option<Value>

Removes the MIME type.

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

An optional title for the attachment.

Important

Attachments with the same title are considered to be alternative representations of an attachment.

pub fn set_title<T>(&mut self, value: T) -> Option<Value>

where T: ToString,

Sets the title.

pub fn remove_title(&mut self) -> Option<Value>

Removes the title.

pub fn size_in_bytes(&self) -> Result<Option<u64>, Error>

The optional size of the attachment in bytes.

pub fn set_size_in_bytes<T>(&mut self, value: u64) -> Option<Value>

Sets the size in bytes.

pub fn remove_size_in_bytes<T>(&mut self) -> Option<Value>

where T: ToString,

Removes the size in bytes.

pub fn duration_in_seconds(&self) -> Result<Option<u64>, Error>

The optional duration of the content in seconds.

pub fn set_duration_in_seconds<T>(&mut self, value: u64) -> Option<Value>

Sets the duration of in seconds.

pub fn remove_duration_in_seconds<T>(&mut self) -> Option<Value>

where T: ToString,

Removes the duration in seconds.

impl Attachment

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 AsMut<Map<String, Value>> for Attachment

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

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

impl AsRef<Map<String, Value>> for Attachment

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

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

impl Clone for Attachment

fn clone(&self) -> Attachment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attachment

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

Formats the value using the given formatter.

impl Default for Attachment

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Attachment

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Map<String, Value>> for Attachment

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

Converts to this type from the input type.

impl PartialEq<Map<String, Value>> for Attachment

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 PartialEq for Attachment

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Attachment