Struct matrix_sdk::media::Media

pub struct Media { /* private fields */ }

A high-level API to interact with the media API.

Implementations

impl Media

pub fn upload(&self, content_type: &Mime, data: Vec<u8>) -> SendUploadRequest

Upload some media to the server.

Arguments

• content_type - The type of the media, this will be used as the content-type header.

• reader - A Reader that will be used to fetch the raw bytes of the media.

Examples

let image = fs::read("/home/example/my-cat.jpg")?;

let response = client.media().upload(&mime::IMAGE_JPEG, image).await?;

println!("Cat URI: {}", response.content_uri);

pub async fn get_media_file( &self, request: &MediaRequest, body: Option<String>, content_type: &Mime, use_cache: bool, temp_dir: Option<String>, ) -> Result<MediaFileHandle>

Available on non-WebAssembly only.

Gets a media file by copying it to a temporary location on disk.

The file won’t be encrypted even if it is encrypted on the server.

Returns a MediaFileHandle which takes ownership of the file. When the handle is dropped, the file will be deleted from the temporary location.

Arguments

• request - The MediaRequest of the content.

• content_type - The type of the media, this will be used to set the temporary file’s extension.

• use_cache - If we should use the media cache for this request.

• temp_dir - Path to a directory where temporary directories can be created. If not provided, a default, global temporary directory will be used; this may not work properly on Android, where the default location may require root access on some older Android versions.

pub async fn get_media_content( &self, request: &MediaRequest, use_cache: bool, ) -> Result<Vec<u8>>

Get a media file’s content.

If the content is encrypted and encryption is enabled, the content will be decrypted.

Arguments

• request - The MediaRequest of the content.

• use_cache - If we should use the media cache for this request.

pub async fn remove_media_content(&self, request: &MediaRequest) -> Result<()>

Remove a media file’s content from the store.

Arguments

• request - The MediaRequest of the content.

pub async fn remove_media_content_for_uri(&self, uri: &MxcUri) -> Result<()>

Delete all the media content corresponding to the given uri from the store.

Arguments

• uri - The MxcUri of the files.

pub async fn get_file( &self, event_content: &impl MediaEventContent, use_cache: bool, ) -> Result<Option<Vec<u8>>>

Get the file of the given media event content.

If the content is encrypted and encryption is enabled, the content will be decrypted.

Returns Ok(None) if the event content has no file.

This is a convenience method that calls the get_media_content method.

Arguments

• event_content - The media event content.

• use_cache - If we should use the media cache for this file.

pub async fn remove_file( &self, event_content: &impl MediaEventContent, ) -> Result<()>

Remove the file of the given media event content from the cache.

This is a convenience method that calls the remove_media_content method.

Arguments

• event_content - The media event content.

pub async fn get_thumbnail( &self, event_content: &impl MediaEventContent, settings: MediaThumbnailSettings, use_cache: bool, ) -> Result<Option<Vec<u8>>>

Get a thumbnail of the given media event content.

If the content is encrypted and encryption is enabled, the content will be decrypted.

Returns Ok(None) if the event content has no thumbnail.

This is a convenience method that calls the get_media_content method.

Arguments

• event_content - The media event content.

• settings - The desired settings of the thumbnail. The actual thumbnail may not match the settings specified.

• use_cache - If we should use the media cache for this thumbnail.

pub async fn remove_thumbnail( &self, event_content: &impl MediaEventContent, settings: MediaThumbnailSettings, ) -> Result<()>

Remove the thumbnail of the given media event content from the cache.

This is a convenience method that calls the remove_media_content method.

Arguments

• event_content - The media event content.

• size - The desired settings of the thumbnail. Must match the settings requested with get_thumbnail.

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.