Struct matrix_sdk :: attachment :: AttachmentConfig Copy item path

impl AttachmentConfig

pub fn new() -> Self

Create a new default AttachmentConfig without providing a thumbnail.

To provide a thumbnail use AttachmentConfig::with_thumbnail().

pub fn generate_thumbnail( self, size: Option<(u32, u32)>, format: ThumbnailFormat, ) -> Self

Available on crate feature image-proc only.

Generate the thumbnail to send for this media.

Uses generate_image_thumbnail().

Thumbnails can only be generated for supported image attachments. For more information, see the image crate.

If generating the thumbnail failed, the error will be logged and sending the attachment will proceed without a thumbnail.

§Arguments

size - The size of the thumbnail in pixels as a (width, height) tuple. If set to None, defaults to (800, 600).
format - The image format to use to encode the thumbnail.

pub fn with_thumbnail(thumbnail: Thumbnail) -> Self

Create a new default AttachmentConfig with a thumbnail.

§Arguments

thumbnail - The thumbnail of the media. If the content_type does not support it (eg audio clips), it is ignored.

To generate automatically a thumbnail from an image, use AttachmentConfig::new() and AttachmentConfig::generate_thumbnail().

pub fn txn_id(self, txn_id: &TransactionId) -> Self

Set the transaction ID to send.

§Arguments

txn_id - A unique ID that can be attached to a MessageEvent held in its unsigned field as transaction_id. If not given, one is created for the message.

pub fn info(self, info: AttachmentInfo) -> Self

Set the media metadata to send.

§Arguments

info - The metadata of the media. If the AttachmentInfo type doesn’t match the content_type, it is ignored.

pub fn caption(self, caption: Option<String>) -> Self

Set the optional caption

§Arguments

caption - The optional caption

pub fn formatted_caption(self, formatted_caption: Option<FormattedBody>) -> Self

Set the optional formatted caption

§Arguments

formatted_caption - The optional formatted caption

pub fn mentions(self, mentions: Option<Mentions>) -> Self

Set the mentions of the message.

§Arguments

mentions - The mentions of the message

Trait Implementations§

impl Debug for AttachmentConfig

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

Formats the value using the given formatter. Read more

impl Default for AttachmentConfig

fn default() -> AttachmentConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl UnwindSafe for AttachmentConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. 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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

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

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

fn with_current_context(self) -> WithContext<Self>

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

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

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

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

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

Consume a handle, getting back the initial Arc<>

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

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

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

const WITNESS: W = W::MAKE

A constant of the type witness

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

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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