Struct ruma_client_api::sync::sync_events::v3::IncomingRequest

source · [−]

pub struct IncomingRequest {
    pub filter: Option<IncomingFilter>,
    pub since: Option<String>,
    pub full_state: bool,
    pub set_presence: PresenceState,
    pub timeout: Option<Duration>,
}

Expand description

‘Incoming’ variant of Request.

Fields

filter: Option<IncomingFilter>

A filter represented either as its full JSON definition or the ID of a saved filter.

since: Option<String>

A point in time to continue a sync from.

Should be a token from the next_batch field of a previous /sync request.

full_state: bool

Controls whether to include the full state for all rooms the user is a member of.

set_presence: PresenceState

Controls whether the client is automatically marked as online by polling this API.

Defaults to PresenceState::Online.

timeout: Option<Duration>

The maximum time to poll in milliseconds before returning this request.

Trait Implementations

source

impl Debug for IncomingRequest

source

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

Formats the value using the given formatter. Read more

source

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

source

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

source

fn try_from_http_request<B, S>(
 request: Request,
 path_args: &[S]
) -> Result<Self, FromHttpRequestError> where
 B: AsRef<[u8 ]>,
 S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments. Read more

Auto Trait Implementations

impl RefUnwindSafe for IncomingRequest

impl Send for IncomingRequest

impl Sync for IncomingRequest

impl Unpin for IncomingRequest

impl UnwindSafe for IncomingRequest

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct ruma_client_api::sync::sync_events::v3::IncomingRequest

Fields

Trait Implementations

impl Debug for IncomingRequest

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

impl IncomingRequest for IncomingRequest

type EndpointError = Error

type OutgoingResponse = Response

const METADATA: Metadata = self::METADATA

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<Self, FromHttpRequestError> where
    B: AsRef<[u8 ]>,
    S: AsRef<str>,

Auto Trait Implementations

impl RefUnwindSafe for IncomingRequest

impl Send for IncomingRequest

impl Sync for IncomingRequest

impl Unpin for IncomingRequest

impl UnwindSafe for IncomingRequest

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct ruma_client_api::sync::sync_events::v3::IncomingRequest

Fields

Trait Implementations

impl Debug for IncomingRequest

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

impl IncomingRequest for IncomingRequest

type EndpointError = Error

type OutgoingResponse = Response

const METADATA: Metadata = self::METADATA

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S]) -> Result<Self, FromHttpRequestError> where B: AsRef<[u8]>, S: AsRef<str>,

Auto Trait Implementations

impl RefUnwindSafe for IncomingRequest

impl Send for IncomingRequest

impl Sync for IncomingRequest

impl Unpin for IncomingRequest

impl UnwindSafe for IncomingRequest

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

fn try_from_http_request<B, S>(
request: Request<B>,
path_args: &[S]
) -> Result<Self, FromHttpRequestError> where
B: AsRef<[u8 ]>,
S: AsRef<str>,

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

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

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

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

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

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

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