Struct ResourceCollection 

pub struct ResourceCollection<T> {
    pub embedded: HashMap<String, Vec<T>>,
    pub links: HashMap<String, LinkOrArray>,
    pub page: Option<PageInfo>,
}

Collection of resources with pagination support

Provides a standardized way to return paginated collections with navigation links.

Example

use rustapi_core::hateoas::{ResourceCollection, PageInfo};
use serde::Serialize;

#[derive(Serialize, Clone)]
struct User {
    id: i64,
    name: String,
}

let users = vec![
    User { id: 1, name: "John".to_string() },
    User { id: 2, name: "Jane".to_string() },
];

let collection = ResourceCollection::new("users", users)
    .self_link("/users?page=1")
    .next_link("/users?page=2")
    .page_info(PageInfo::new(20, 100, 5, 1));

Fields

embedded: HashMap<String, Vec<T>>

Embedded resources

links: HashMap<String, LinkOrArray>

Navigation links

page: Option<PageInfo>

Pagination information

Implementations

impl<T> ResourceCollection<T>

pub fn new(rel: impl Into<String>, items: Vec<T>) -> Self

Create a new resource collection

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

Add a link

pub fn self_link(self, href: impl Into<String>) -> Self

Add self link

pub fn first_link(self, href: impl Into<String>) -> Self

Add first page link

pub fn last_link(self, href: impl Into<String>) -> Self

Add last page link

pub fn next_link(self, href: impl Into<String>) -> Self

Add next page link

pub fn prev_link(self, href: impl Into<String>) -> Self

Add previous page link

pub fn page_info(self, page: PageInfo) -> Self

Set page info

pub fn with_pagination(self, base_url: &str) -> Self

Build pagination links from page info

Trait Implementations

impl<T: Clone> Clone for ResourceCollection<T>

fn clone(&self) -> ResourceCollection<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ResourceCollection<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ResourceCollection<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for ResourceCollection<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.