Struct AttachmentRef

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

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

Implementations

impl<'a> AttachmentRef<'a>

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

Returns the inner Map as a reference.

impl<'a> AttachmentRef<'a>

pub fn to_attachment(&self) -> Attachment

Clones the inner Map reference and returns an owned type.

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

The required URL for the attachment.

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

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

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 size_in_bytes(&self) -> Result<Option<u64>, Error>

The optional size of the attachment in bytes.

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

The optional duration of the content in seconds.

impl AttachmentRef<'_>

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

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

Formats the value using the given formatter.

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

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