Struct dot4ch::Catalog

pub struct Catalog { /* private fields */ }

A summarized list of all threads on a board including thread numbers, their modification time and reply count.

Example

let catalog = Catalog::new(&client, "g").await.unwrap();

// print the first page

println!("{:?}", catalog.page(0));

to get all threads from catalog

Implementations

impl Catalog

pub async fn new(
    client: &Arc<Mutex<Client>>,
    board: &str
) -> Result<Self, DotError>

Returns a new Catalog from a given board.

Errors

This function will return an error if the board isn’t valid

pub fn update_time(self)

Updates the last accessed time to be the current time.

pub fn page(&self, index: usize) -> Option<&Page>

Returns a reference to the [Page] if it exists. None otherwise

pub fn all_pages(self) -> Vec<Page>

Returns all the [Page]s from the Catalog.

Trait Implementations

impl Debug for Catalog

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

Formats the value using the given formatter.

impl IfModifiedSince for Catalog

fn fetch<'life0, 'life1, 'life2, 'async_trait>(
    client: &'life0 Arc<Mutex<Client>>,
    url: &'life1 str,
    header: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<Response, DotError>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait, 

Fetches the given URL with an If-Modifed-Since header.

impl<Idx> Index<Idx> for Catalog where
    Idx: SliceIndex<[Page]>, 

type Output = <Idx as SliceIndex<[Page]>>::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Procedures for Catalog

fn refresh_time<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), DotError>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Refreshes the time in the Thread instance. also handles the sleep of the thread update.

Errors

This function should probably not fail but can fail if the subtraction from time::Duration results in an overflow which normally should not occur, in which case, the program will panic

fn fetch_status<'async_trait>(
    self,
    response: Response
) -> Pin<Box<dyn Future<Output = Result<Self::Output, DotError>> + 'async_trait>> where
    Self: 'async_trait, 

Updates the status of a Response and generates a new Catalog if needed.

fn from_response<'async_trait>(
    self,
    response: Response
) -> Pin<Box<dyn Future<Output = Result<Self::Output, DotError>> + 'async_trait>> where
    Self: 'async_trait, 

Converts the Response into a Catalog

type Output = Catalog

The Output type.

impl Update for Catalog

fn update<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<Self, DotError>> + 'async_trait>> where
    Self: 'async_trait, 

Returns an updated catalog.

type Output = Catalog

The type of the output.