trakt-core 0.2.1

Core library for trakt-rs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use crate::error::FromHttpError;

/// A trait for converting an HTTP response into a result of `Self`.
pub trait Response: Sized {
    /// Converts an HTTP response into a result of `Self`, where `Self` refers to the implementing type.
    ///
    /// # Arguments
    ///
    /// * `response` - The HTTP response to convert.
    ///
    /// # Errors
    ///
    /// Will error if the HTTP response is not a succeeding status code as determined by the
    /// type or if the response body cannot be deserialized into the implementing type.
    ///
    /// See [`FromHttpError`] for more details.
    fn try_from_http_response<T: AsRef<[u8]>>(
        response: http::Response<T>,
    ) -> Result<Self, FromHttpError>;
}

/// A sub-trait of `Response` for paginated responses.
pub trait PaginatedResponse: Response {
    /// The type of item that the paginated response contains.
    type Item;

    /// Returns a slice of the items in the current page of the paginated response.
    fn items(&self) -> &[Self::Item];

    /// Returns the pagination of the next page of the paginated response.
    fn next_page(&self) -> Option<crate::Pagination>;
}