Trait teloxide_core::requests::HasPayload

pub trait HasPayload {
    type Payload: Payload;

    // Required methods
    fn payload_mut(&mut self) -> &mut Self::Payload;
    fn payload_ref(&self) -> &Self::Payload;

    // Provided method
    fn with_payload_mut<F>(self, f: F) -> Self
       where Self: Sized,
             F: FnOnce(&mut Self::Payload) { ... }
}

Represents types having payload inside.

This trait is something between DerefMut and BorrowMut — it allows only one implementation per type (the output type is associated, not generic), has implementations for all types P such P: Payload, but has no magic compiler support like DerefMut does nor does it require any laws about Eq, Ord and Hash as BorrowMut does.

Also the output type is bounded by the Payload trait.

This trait is mostly used to implement payload setters (on both payloads & requests), so you probably won’t find yourself using it directly.

Required Associated Types

type Payload: Payload

The type of the payload contained.

Required Methods

fn payload_mut(&mut self) -> &mut Self::Payload

Gain mutable access to the underlying payload.

fn payload_ref(&self) -> &Self::Payload

Gain immutable access to the underlying payload.

Provided Methods

fn with_payload_mut<F>(self, f: F) -> Self

where Self: Sized, F: FnOnce(&mut Self::Payload),

Update payload with a function

Implementations on Foreign Types

impl<L, R> HasPayload for Either<L, R>

where L: HasPayload, R: HasPayload<Payload = L::Payload>,

type Payload = <L as HasPayload>::Payload

fn payload_mut(&mut self) -> &mut Self::Payload

fn payload_ref(&self) -> &Self::Payload

Implementors

impl<P> HasPayload for JsonRequest<P>

where P: Payload,

type Payload = P

impl<P> HasPayload for MultipartRequest<P>

where P: Payload,

type Payload = P

impl<P> HasPayload for P

where P: Payload,

type Payload = P

impl<R> HasPayload for TraceRequest<R>

where R: HasPayload,

Available on crate feature trace_adaptor only.

type Payload = <R as HasPayload>::Payload

impl<R: HasPayload + Clone> HasPayload for ThrottlingRequest<R>

Available on crate feature throttle only.

type Payload = <R as HasPayload>::Payload

impl<R: Request<Payload = GetMe>> HasPayload for CachedMeRequest<R>

Available on crate feature cache_me only.

type Payload = GetMe

impl<T, E> HasPayload for ErasedRequest<'_, T, E>

where T: Payload,

Available on crate feature erased only.

type Payload = T