Struct Response 

#[non_exhaustive]
pub struct Response {
    pub signatures: Signatures<OwnedServerName, ServerSigningKeyVersion>,
}

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

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

signatures: Signatures<OwnedServerName, ServerSigningKeyVersion>

A map containing the Policy Server’s signature of the event.

This signature is to be added to the event before sending or processing the event further.

ed25519:policy_server is always used for Ed25519 signatures.

Implementations

impl Response

pub const POLICY_SERVER_ED25519_SIGNING_KEY_ID: &'static str = "ed25519:policy_server"

The signing key ID that must be used by the Policy Server for the ed25519 signature.

pub fn new(server_name: OwnedServerName, ed25519_signature: String) -> Response

Creates a new Response with the given Policy Server name and event signature.

pub fn ed25519_signature(&self, server_name: &ServerName) -> Option<&str>

Get the signature of the event for the given Policy Server name, if any.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a duplicate 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 = Error

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

fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>

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.