Struct ruma::api::federation::discovery::get_remote_server_keys_batch::v2::Request

pub struct Request {
    pub server_keys: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, KeyName>, QueryCriteria, Global>, Global>,
}

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

Data for a request to the get_remote_server_keys_batch API endpoint.

Query for keys from multiple servers in a batch format.

Fields

server_keys: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, KeyName>, QueryCriteria, Global>, Global>

The query criteria.

The outer string key on the object is the server name (eg: matrix.org). The inner string key is the Key ID to query for the particular server. If no key IDs are given to be queried, the notary server should query for all keys. If no servers are given, the notary server must return an empty server_keys array in the response.

The notary server may return multiple keys regardless of the Key IDs given.

Implementations

impl Request

pub fn new(
    server_keys: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, KeyName>, QueryCriteria, Global>, Global>
) -> Request

Creates a new Request with the given query criteria.

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<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

type EndpointError = MatrixError

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<Request, 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.

type EndpointError = MatrixError

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

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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

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

impl IncomingNonAuthRequest for Request

Available on crate feature server only.

impl OutgoingNonAuthRequest for Request

Available on crate feature client only.