Trait TileSource

Source

pub trait TileSource: Send + Sync {
    // Required methods
    fn request(&self, id: TileId);
    fn poll(&self) -> Vec<(TileId, Result<TileResponse, TileError>)>;

    // Provided methods
    fn request_many(&self, ids: &[TileId]) { ... }
    fn request_revalidate(&self, id: TileId, _hint: RevalidationHint) { ... }
    fn request_revalidate_many(&self, ids: &[(TileId, RevalidationHint)]) { ... }
    fn cancel(&self, _id: TileId) { ... }
    fn cancel_many(&self, ids: &[TileId]) { ... }
    fn diagnostics(&self) -> Option<TileSourceDiagnostics> { ... }
}

Expand description

A tile source that can fetch tiles by ID.

The engine does not own an async runtime. The host provides completed results via polling or callbacks.

Required Methods§

Source

fn request(&self, id: TileId)

Start fetching a tile. Returns immediately.

The implementation should arrange for the result to be retrievable via TileSource::poll.

Source

fn poll(&self) -> Vec<(TileId, Result<TileResponse, TileError>)>

Poll for completed tile fetches.

Returns a vector of (TileId, Result) pairs for all tiles that have completed since the last poll.

Provided Methods§

Source

fn request_many(&self, ids: &[TileId])

Start fetching multiple tiles.

The default implementation forwards to request in-order, but implementations may override this to batch or reprioritize work internally.

Source

fn request_revalidate(&self, id: TileId, _hint: RevalidationHint)

Start a conditional revalidation fetch for a stale tile.

Implementations that support conditional revalidation should attach If-None-Match / If-Modified-Since headers derived from hint so the server can respond with 304 Not Modified when the tile has not changed.

The default implementation ignores the hint and falls back to a normal request.

Source