Struct WebFingerResponse

pub struct WebFingerResponse {
    pub subject: String,
    pub aliases: Option<Vec<String>>,
    pub properties: Option<HashMap<String, String>>,
    pub links: Vec<Link>,
}

A WebFinger response.

This represents the response portion of a WebFinger query that is returned by a WebFinger server.

See RFC 7033 Section 4.4 for more information.

Examples

use webfinger_rs::{Link, WebFingerResponse};

let avatar = Link::builder("http://webfinger.net/rel/avatar")
    .href("https://example.com/avatar.png")
    .build();
let profile = Link::builder("http://webfinger.net/rel/profile-page")
    .href("https://example.com/profile/carol")
    .build();
let response = WebFingerResponse::builder("acct:carol@example.com")
    .alias("https://example.com/profile/carol")
    .property("https://example.com/ns/role", "developer")
    .link(avatar)
    .link(profile)
    .build();

Response can be used as a response in Axum handlers as it implements axum::response::IntoResponse.

use axum::response::IntoResponse;
use webfinger_rs::{Link, WebFingerRequest, WebFingerResponse};

async fn handler(request: WebFingerRequest) -> WebFingerResponse {
    // ... handle the request ...
    WebFingerResponse::builder("acct:carol@example.com")
        .alias("https://example.com/profile/carol")
        .property("https://example.com/ns/role", "developer")
        .link(
            Link::builder("http://webfinger.net/rel/avatar")
                .href("https://example.com/avatar.png"),
        )
        .build()
}

Fields

subject: String

The subject of the response.

This is the URI of the resource that the response is about.

Defined in RFC 7033 Section 4.4.1

aliases: Option<Vec<String>>

The aliases of the response.

Defined in RFC 7033 Section 4.4.2

properties: Option<HashMap<String, String>>

The properties of the response.

Defined in RFC 7033 Section 4.4.3

links: Vec<Link>

The links of the response.

Defined in RFC 7033 Section 4.4.4

Implementations

impl WebFingerResponse

pub async fn try_from_reqwest( response: Response, ) -> Result<WebFingerResponse, Error>

Available on crate feature reqwest only.

Converts a reqwest response into a WebFinger response.

impl Response

pub fn new<S: Into<String>>(subject: S) -> Self

Create a new response with the given subject.

pub fn builder<S: Into<String>>(subject: S) -> Builder

Create a new Builder with the given subject.

Examples

use webfinger_rs::{Link, WebFingerResponse};

let avatar =
    Link::builder("http://webfinger.net/rel/avatar").href("https://example.com/avatar.png");
let response = WebFingerResponse::builder("acct:carol@example.com")
    .alias("https://example.com/profile/carol")
    .property("https://example.com/ns/role", "developer")
    .link(avatar)
    .build();

Examples found in repository

examples/actix.rs (line 57)

async fn webfinger(request: WebFingerRequest) -> actix_web::Result<WebFingerResponse> {
    info!("fetching webfinger resource: {:?}", request);
    let subject = request.resource.to_string();
    if subject != SUBJECT {
        let message = format!("{subject} does not exist");
        return Err(actix_web::error::ErrorNotFound(message))?;
    }
    let rel = Rel::new("http://webfinger.net/rel/profile-page");
    let response = if request.rels.is_empty() || request.rels.contains(&rel) {
        let link = Link::builder(rel).href(format!("https://example.com/profile/{subject}"));
        WebFingerResponse::builder(subject).link(link).build()
    } else {
        WebFingerResponse::builder(subject).build()
    };
    Ok(response)
}

examples/axum.rs (line 57)

async fn webfinger(request: WebFingerRequest) -> axum::response::Result<WebFingerResponse> {
    info!("fetching webfinger resource: {:?}", request);
    let subject = request.resource.to_string();
    if subject != SUBJECT {
        let message = format!("{subject} does not exist");
        return Err((StatusCode::NOT_FOUND, message).into());
    }
    let rel = Rel::new("http://webfinger.net/rel/profile-page");
    let response = if request.rels.is_empty() || request.rels.contains(&rel) {
        let link = Link::builder(rel).href(format!("https://example.com/profile/{subject}"));
        WebFingerResponse::builder(subject).link(link).build()
    } else {
        WebFingerResponse::builder(subject).build()
    };
    Ok(response)
}

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

Custom debug implementation to avoid printing None fields

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Response

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

Formats the value using the given formatter.

impl IntoResponse for WebFingerResponse

Available on crate feature axum only.

fn into_response(self) -> AxumResponse

Converts a WebFinger response into an axum response.

This is used to convert a WebFingerResponse into an axum response in an axum route handler. The response will be serialized as JSON and the Content-Type header will be set to application/jrd+json.

See the axum example for more information.

Example

use axum::response::IntoResponse;
use webfinger_rs::{Link, WebFingerRequest, WebFingerResponse};

async fn handler(request: WebFingerRequest) -> impl IntoResponse {
    // ... your code to handle the webfinger request ...
    let subject = request.resource.to_string();
    let link = Link::builder("http://webfinger.net/rel/profile-page")
        .href(format!("https://example.com/profile/{subject}"));
    WebFingerResponse::builder(subject).link(link).build()
}

impl PartialEq for Response

fn eq(&self, other: &Response) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Responder for WebFingerResponse

Available on crate feature actix only.

type Body = <Json<Response> as Responder>::Body

fn respond_to(self, _request: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.

impl Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Response> for Response<()>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(_: &WebFingerResponse) -> Result<Response<()>, Error>

Performs the conversion.

impl TryFrom<Response> for WebFingerResponse

Available on crate feature reqwest only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from<'async_trait>( response: Response, ) -> Pin<Box<dyn Future<Output = Result<WebFingerResponse, Error>> + Send + 'async_trait>>

Performs the conversion.

impl Eq for Response

impl StructuralPartialEq for Response