Struct ruma_client_api::room::get_event_by_timestamp::v1::Request

pub struct Request {
    pub room_id: OwnedRoomId,
    pub ts: MilliSecondsSinceUnixEpoch,
    pub dir: Direction,
}

Available on crate features client or server only.

Request type for the get_event_by_timestamp endpoint.

Fields

room_id: OwnedRoomId

The ID of the room the event is in.

ts: MilliSecondsSinceUnixEpoch

The timestamp to search from, inclusively.

dir: Direction

The direction in which to search.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch, dir: Direction, ) -> Self

Creates a new Request with the given room ID, timestamp and direction.

pub fn until(room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch) -> Self

Creates a new Request with the given room ID and timestamp, and the direction set to Backward.

Allows to have the latest event before or including the given timestamp.

pub fn since(room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch) -> Self

Creates a new Request with the given room ID and timestamp, and the direction set to Forward.

Allows to have the earliest event including or after the given timestamp.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

fn try_from_http_request<B, S>( request: Request<B>, 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.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.