Struct Book 

pub struct Book<E> { /* private fields */ }

Model to represent a book of paginated items.

Fields:

• sheets: Represents the sheets in a Book as a Vec of Page.

Implementations

impl<E> Book<E>

pub fn get_sheets(&self) -> &Vec<Page<E>>

Get sheets

pub fn new(sheets: &Vec<Page<E>>) -> Book<E>

where E: Clone,

Create a new Book instance.

Arguments:

• sheets: A reference to a Vec of Page, where E must implement Clone.

Returns:

A Book if successful, otherwise a PaginationError is returned.

Example:

  use page_hunter::*;

  let sheets: Vec<Page<u32>> = vec![
    Page::new(&vec![1, 2], 0, 2, 5).unwrap_or_else(|error| {
      panic!("Error creating page model: {:?}", error);
    }),
    Page::new(&vec![3, 4], 1, 2, 5).unwrap_or_else(|error| {
      panic!("Error creating page model: {:?}", error);
    }),
  ];

  let book: Book<u32> = Book::new(&sheets);

Trait Implementations

impl<E: Clone> Clone for Book<E>

fn clone(&self) -> Book<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> ComposeSchema for Book<E>

where E: ToSchema,

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl<E: Debug> Debug for Book<E>

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

Formats the value using the given formatter.

impl<E> Default for Book<E>

Implementation of Default for Book.

fn default() -> Self

Returns the “default value” for a type.

impl<'de, E> Deserialize<'de> for Book<E>

where E: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> Display for Book<E>

where E: Debug,

Implementation of Display for Book.

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

Formats the value using the given formatter.

impl<E> IntoIterator for Book<E>

Implementation of IntoIterator for Book.

type Item = Page<E>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Book<E> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E> Serialize for Book<E>

where E: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<E> ToSchema for Book<E>

where E: ToSchema,

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.