Skip to main content

BrowseEnvelope

Struct BrowseEnvelope 

Source
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: Meta

Pagination metadata.

Trait Implementations§

Source§

impl<T: Clone> Clone for BrowseEnvelope<T>

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for BrowseEnvelope<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, T: DeserializeOwned> Deserialize<'de> for BrowseEnvelope<T>

Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more