Struct Media

pub struct Media {
    pub content: Vec<MediaType>,
}

A Media is a collection of data associated with different Media types. It allows for the representation of rich content that can be displayed in multiple formats. These are found in the data field of a DisplayData and ExecuteResult messages/output types.

Fields

content: Vec<MediaType>

A map of Media types to their corresponding data, represented as JSON Value.

Implementations

impl Media

pub fn richest(&self, ranker: fn(_: &MediaType) -> usize) -> Option<&MediaType>

Find the richest media type in the bundle, based on the provided ranker function. A rank of 0 indicates that the media type is not supported. Higher numbers indicate that the media type is preferred over other media types.

Examples

use jupyter_serde::media::{Media, MediaType};

let raw = r#"{
   "text/plain": "FancyThing()",
   "text/html": "<h1>Fancy!</h1>",
   "application/json": {"fancy": true}
}"#;

let media: Media = serde_json::from_str(raw).unwrap();

let ranker = |media_type: &MediaType| match media_type {
   MediaType::Html(_) => 3,
   MediaType::Json(_) => 2,
   MediaType::Plain(_) => 1,
   _ => 0,
};

let richest = media.richest(ranker);

assert_eq!(
   richest,
   Some(MediaType::Html(String::from("<h1>Fancy!</h1>"))).as_ref()
);

pub fn new(content: Vec<MediaType>) -> Self

Trait Implementations

impl Clone for Media

fn clone(&self) -> Media

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Media

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

Formats the value using the given formatter.

impl Default for Media

fn default() -> Media

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Media

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MediaType> for Media

fn from(media_type: MediaType) -> Self

Converts to this type from the input type.

impl Serialize for Media

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.