Struct matrix_sdk::media::Media

source ·
pub struct Media { /* private fields */ }
Expand description

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

Implementations§

source§

impl Media

source

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);
source

pub async fn create_content_uri(&self) -> Result<PreallocatedMxcUri>

Preallocates an MXC URI for a media that will be uploaded soon.

This preallocates an URI before any content is uploaded to the server. The resulting preallocated MXC URI can then be consumed with Media::upload_preallocated.

§Examples

let preallocated = client.media().create_content_uri().await?;
println!("Cat URI: {}", preallocated.uri);

let image = fs::read("/home/example/my-cat.jpg")?;
client
    .media()
    .upload_preallocated(preallocated, &mime::IMAGE_JPEG, image)
    .await?;
source

pub async fn upload_preallocated( &self, uri: PreallocatedMxcUri, content_type: &Mime, data: Vec<u8>, ) -> Result<()>

Fills the content of a preallocated MXC URI with the given content type and data.

The URI must have been preallocated with Self::create_content_uri. See this method’s documentation for a full example.

source

pub async fn get_media_file( &self, request: &MediaRequestParameters, filename: 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.

  • filename - The filename specified in the event. It is suggested to use the filename() method on the event’s content instead of using the filename field directly. If not provided, a random name will be generated.

  • content_type - The type of the media, this will be used to set the temporary file’s extension when one isn’t included in the filename.

  • 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.

source

pub async fn get_media_content( &self, request: &MediaRequestParameters, 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.

source

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

Remove a media file’s content from the store.

§Arguments
  • request - The MediaRequest of the content.
source

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.
source

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.

source

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.
source

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.

source

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§

source§

impl Clone for Media

source§

fn clone(&self) -> Media

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Media

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Media

§

impl !RefUnwindSafe for Media

§

impl Send for Media

§

impl Sync for Media

§

impl Unpin for Media

§

impl !UnwindSafe for Media

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromRef<T> for T
where T: Clone,

source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
source§

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
source§

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>
source§

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> Any for T
where T: Any,

source§

impl<T> AsyncTraitDeps for T

source§

impl<T> CloneAny for T
where T: Any + Clone,

source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

source§

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,