Struct Response

#[non_exhaustive]
pub struct Response {
    pub contacts: Vec<Contact>,
    pub support_page: Option<String>,
}

Available on crate features client or server only.

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

contacts: Vec<Contact>

Ways to contact the server administrator.

At least one of contacts or support_page is required. If only contacts is set, it must contain at least one item.

support_page: Option<String>

The URL of a page to give users help specific to the homeserver, like extra login/registration steps.

At least one of contacts or support_page is required.

Implementations

impl Response

pub fn with_contacts(contacts: Vec<Contact>) -> Self

Creates a new Response with the given contacts.

pub fn with_support_page(support_page: String) -> Self

Creates a new Response with the given support page.

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

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: AsRef<[u8]>>( response: Response<T>, ) -> Result<Self, FromHttpResponseError<Error>>

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: Default + BufMut>( self, ) -> Result<Response<T>, IntoHttpError>

Tries to convert this response into an http::Response.