Struct Response

#[non_exhaustive]
pub struct Response {
    pub lookup_pepper: String,
    pub algorithms: Vec<IdentifierHashingAlgorithm>,
}

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

Response type for the get_hash_parameters 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.

lookup_pepper: String

The pepper the client MUST use in hashing identifiers, and MUST supply to the /lookup endpoint when performing lookups.

Servers SHOULD rotate this string often.

algorithms: Vec<IdentifierHashingAlgorithm>

The algorithms the server supports.

Must contain at least sha256.

Implementations

impl Response

pub fn new( lookup_pepper: String, algorithms: Vec<IdentifierHashingAlgorithm>, ) -> Response

Create a new Response using the given pepper and Vec of algorithms.

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.