pub struct BrowseEnvelope<T> {
pub items: Vec<T>,
pub meta: Meta,
}Expand description
Response envelope for Ghost browse endpoints.
Browse endpoints return {"<resource>": [...], "meta": {...}}. The resource
key differs by type ("posts", "tags", "authors", …), but the shape is
always the same: an array of items plus a "meta" block containing
pagination details.
BrowseEnvelope<T> deserializes any such object by scanning for the first
array-valued field that is not "meta". You never need to specify the
resource key; the same type works for every Ghost resource.
§Fields
items— the deserialized resource objects from the current page.meta— pagination metadata (page,limit,pages,total, …).
§Example
use ghost_io_api::models::envelope::BrowseEnvelope;
use serde::Deserialize;
use serde_json::json;
#[derive(Debug, Deserialize)]
struct Post { id: String, title: String }
let json = json!({
"posts": [{"id": "abc", "title": "Hello"}],
"meta": {
"pagination": {"page": 1, "limit": 15, "pages": 1, "total": 1}
}
});
let env: BrowseEnvelope<Post> = serde_json::from_value(json).unwrap();
assert_eq!(env.items[0].id, "abc");
assert_eq!(env.meta.pagination.page, 1);
assert_eq!(env.meta.pagination.total, 1);Fields§
§items: Vec<T>The resource items returned by this page.
meta: MetaPagination metadata.
Trait Implementations§
Source§impl<T: Clone> Clone for BrowseEnvelope<T>
impl<T: Clone> Clone for BrowseEnvelope<T>
Source§fn clone(&self) -> BrowseEnvelope<T>
fn clone(&self) -> BrowseEnvelope<T>
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<T: Debug> Debug for BrowseEnvelope<T>
impl<T: Debug> Debug for BrowseEnvelope<T>
Source§impl<'de, T: DeserializeOwned> Deserialize<'de> for BrowseEnvelope<T>
impl<'de, T: DeserializeOwned> Deserialize<'de> for BrowseEnvelope<T>
Source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl<T> Freeze for BrowseEnvelope<T>
impl<T> RefUnwindSafe for BrowseEnvelope<T>where
T: RefUnwindSafe,
impl<T> Send for BrowseEnvelope<T>where
T: Send,
impl<T> Sync for BrowseEnvelope<T>where
T: Sync,
impl<T> Unpin for BrowseEnvelope<T>where
T: Unpin,
impl<T> UnsafeUnpin for BrowseEnvelope<T>
impl<T> UnwindSafe for BrowseEnvelope<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more