Struct ruma_client_api::state::send_state_event::v3::Request
source · [−]pub struct Request<'a> {
pub room_id: &'a RoomId,
pub event_type: StateEventType,
pub state_key: &'a str,
pub body: Raw<AnyStateEventContent>,
pub timestamp: Option<MilliSecondsSinceUnixEpoch>,
}
Available on crate features
client
or server
only.Expand description
Data for a request to the send_state_event
API endpoint.
Send a state event to a room associated with a given state key.
Fields
room_id: &'a RoomId
The room to set the state in.
event_type: StateEventType
The type of event to send.
state_key: &'a str
The state_key for the state to send.
body: Raw<AnyStateEventContent>
The event content to send.
timestamp: Option<MilliSecondsSinceUnixEpoch>
Timestamp to use for the origin_server_ts
of the event.
This is called timestamp massaging and can only be used by Appservices.
Note that this does not change the position of the event in the timeline.
Implementations
sourceimpl<'a> Request<'a>
impl<'a> Request<'a>
sourcepub fn new<T, K>(
room_id: &'a RoomId,
state_key: &'a K,
content: &'a T
) -> Result<Self>where
T: StateEventContent,
T::StateKey: Borrow<K>,
K: AsRef<str> + ?Sized,
pub fn new<T, K>(
room_id: &'a RoomId,
state_key: &'a K,
content: &'a T
) -> Result<Self>where
T: StateEventContent,
T::StateKey: Borrow<K>,
K: AsRef<str> + ?Sized,
sourcepub fn new_raw(
room_id: &'a RoomId,
event_type: StateEventType,
state_key: &'a str,
body: Raw<AnyStateEventContent>
) -> Self
pub fn new_raw(
room_id: &'a RoomId,
event_type: StateEventType,
state_key: &'a str,
body: Raw<AnyStateEventContent>
) -> Self
Creates a new Request
with the given room id, event type, state key and raw event
content.
Trait Implementations
sourceimpl<'a> OutgoingRequest for Request<'a>
Available on crate feature client
only.
impl<'a> OutgoingRequest for Request<'a>
Available on crate feature
client
only.type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
sourcefn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>
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
. Read moreAuto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> Send for Request<'a>
impl<'a> Sync for Request<'a>
impl<'a> Unpin for Request<'a>
impl<'a> UnwindSafe for Request<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
sourcefn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity. Read more