Struct Response

#[non_exhaustive]
pub struct Response {
    pub user_id: OwnedUserId,
    pub stream_id: UInt,
    pub devices: Vec<UserDevice>,
    pub master_key: Option<Raw<CrossSigningKey>>,
    pub self_signing_key: Option<Raw<CrossSigningKey>>,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

Response type for the get_devices endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: OwnedUserId

The user ID devices were requested for.

stream_id: UInt

A unique ID for a given user_id which describes the version of the returned device list.

This is matched with the stream_id field in m.device_list_update EDUs in order to incrementally update the returned device_list.

devices: Vec<UserDevice>

The user’s devices.

master_key: Option<Raw<CrossSigningKey>>

The user’s master key.

self_signing_key: Option<Raw<CrossSigningKey>>

The users’s self-signing key.

Implementations

impl Response

pub fn new(user_id: OwnedUserId, stream_id: UInt) -> Response

Creates a new Response with the given user id and stream id.

The device list will be empty.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl IncomingResponse for Response

Available on crate feature client only.

type EndpointError = MatrixError

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

fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<MatrixError>>

where T: AsRef<[u8]>,

Tries to convert the given http::Response into this response type.

impl OutgoingResponse for Response

Available on crate feature server only.

fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this response into an http::Response.