Struct ruma::api::identity_service::lookup::lookup_3pid::v2::IncomingRequest

pub struct IncomingRequest {
    pub algorithm: IdentifierHashingAlgorithm,
    pub pepper: String,
    pub addresses: Vec<String, Global>,
}

This is supported on crate feature api and (crate features identity-service-api or identity-service-api-c or identity-service-api-s) only.

‘Incoming’ variant of Request.

Fields

algorithm: IdentifierHashingAlgorithm

The algorithm the client is using to encode the addresses. This should be one of the available options from /hash_details.

pepper: String

The pepper from /hash_details. This is required even when the algorithm does not make use of it.

addresses: Vec<String, Global>

The addresses to look up. The format of the entries here depend on the algorithm used. Note that queries which have been incorrectly hashed or formatted will lead to no matches.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

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.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_from_http_request<T>(
    request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
    T: AsRef<[u8]>, 

Tries to turn the given http::Request into this request type.