Struct LinkHeader 

pub struct LinkHeader { /* private fields */ }

Builder for constructing RFC 8288 Link headers.

Supports multiple links in a single header value, pagination helpers, and custom relation types.

Example

use fastapi_core::{LinkHeader, LinkRel};

let header = LinkHeader::new()
    .link("https://api.example.com/users?page=2", LinkRel::Next)
    .link("https://api.example.com/users?page=1", LinkRel::Prev)
    .link("https://api.example.com/users?page=1", LinkRel::First)
    .link("https://api.example.com/users?page=5", LinkRel::Last);

assert!(header.to_string().contains("rel=\"next\""));

Implementations

impl LinkHeader

pub fn new() -> Self

Create an empty link header builder.

pub fn link(self, url: impl Into<String>, rel: LinkRel) -> Self

Add a link with the given URL and relation.

pub fn add(self, link: Link) -> Self

Add a fully configured Link entry.

pub fn paginate( self, base_url: &str, page: u64, per_page: u64, total: u64, ) -> Self

Add pagination links from page/per_page/total parameters.

Generates first, last, next, prev, and self links using the given base URL and query parameters.

pub fn is_empty(&self) -> bool

Returns true if no links have been added.

pub fn len(&self) -> usize

Returns the number of links.

pub fn to_header_value(&self) -> String

Convert to the header value string (RFC 8288 format).

pub fn apply(self, response: Response) -> Response

Apply this Link header to a response.

Trait Implementations

impl Clone for LinkHeader

fn clone(&self) -> LinkHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkHeader

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

Formats the value using the given formatter.

impl Default for LinkHeader

fn default() -> LinkHeader

Returns the “default value” for a type.

impl Display for LinkHeader

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

Formats the value using the given formatter.