Struct DataSourceRequest

pub struct DataSourceRequest { /* private fields */ }

Represents a request to a DataSource for a tile.

Data sources can return a tile multiple times. For example, a TileDownloader may return cached data first, then later return data from a network service when it arrives. This allows the map to be rendered as quickly as possible without waiting for the network unnecessarily.

Conventional async/finish method pairs don’t support multiple returns. Instead, DataSourceExt::start_request() is available, which returns a DataSourceRequest whose properties, data and error, update as data becomes available. The [notify][struct@crate::glib::Object#notify] signal can be used to watch for these changes. When the request is done and no more data will be returned, completed is set to true.

DataSource implementations can use a subclass of DataSourceRequest, but the base class should be sufficient in most cases.

Properties

completed

true if the request has been completed, otherwise false. A completed request will not receive further updates to either data or error.

Readable

data

The most recent data for the tile, if available. If an error is emitted, this will be set to None.

Readable

error

The error that occurred during the request, if any.

Readable

x

The X coordinate of the requested tile.

Readable | Writeable | Construct Only

y

The Y coordinate of the requested tile.

Readable | Writeable | Construct Only

zoom-level

The zoom level of the requested tile.

Readable | Writeable | Construct Only

Implements

DataSourceRequestExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl DataSourceRequest

pub const NONE: Option<&'static DataSourceRequest> = None

pub fn new(x: i32, y: i32, zoom_level: i32) -> DataSourceRequest

Creates a new DataSourceRequest.

Only implementations of DataSourceImpl::start_request() should need to construct a new request object.

x

X coordinate of the requested tile

y

Y coordinate of the requested tile

zoom_level

Zoom level of the requested tile

Returns

a new DataSourceRequest

pub fn builder() -> DataSourceRequestBuilder

Creates a new builder-pattern struct instance to construct DataSourceRequest objects.

This method returns an instance of DataSourceRequestBuilder which can be used to create DataSourceRequest objects.

Trait Implementations

impl Clone for DataSourceRequest

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for DataSourceRequest

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

Formats the value using the given formatter.

impl Default for DataSourceRequest

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for DataSourceRequest

type ParamSpec = ParamSpecObject

type SetValue = DataSourceRequest

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, DataSourceRequest>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DataSourceRequest

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DataSourceRequest

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for DataSourceRequest

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DataSourceRequest

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DataSourceRequest

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DataSourceRequest

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DataSourceRequest