Struct Request

#[non_exhaustive]
pub struct Request {
    pub algorithm: IdentifierHashingAlgorithm,
    pub pepper: String,
    pub addresses: Vec<String>,
}

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

Request type for the lookup_3pid 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.

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>

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.

Implementations

impl Request

pub fn new( algorithm: IdentifierHashingAlgorithm, pepper: String, addresses: Vec<String>, ) -> Request

Create a Request with algorithm, pepper and addresses to loop up.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.