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

pub struct Request<'a> {
    pub algorithm: &'a IdentifierHashingAlgorithm,
    pub pepper: &'a str,
    pub addresses: &'a [String],
}

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

Data for a request to the lookup_3pid API endpoint.

Looks up the set of Matrix User IDs which have bound the 3PIDs given, if bindings are available.

Fields

algorithm: &'a IdentifierHashingAlgorithm

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

pepper: &'a str

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

addresses: &'a [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<'a> Request<'a>

pub fn new(
    algorithm: &'a IdentifierHashingAlgorithm,
    pepper: &'a str,
    addresses: &'a [String]
) -> Request<'a>

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

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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.