Skip to main content

ProgressDto

Enum ProgressDto 

Source
pub enum ProgressDto {
    PlanComputed {
        zoom_level: u8,
        total_tiles: u32,
    },
    TileStarted {
        zoom: u8,
        x: u32,
        y: u32,
    },
    TileFinished {
        zoom: u8,
        x: u32,
        y: u32,
        outcome: &'static str,
    },
    RegionCheckPlanned {
        total_regions: u32,
    },
    RegionChecked {
        x: u32,
        y: u32,
        exists: bool,
    },
    RoutePlanned {
        total_waypoints: usize,
    },
    RouteWaypointResolved {
        index: usize,
        total: usize,
        region: String,
    },
    RegionNamesPlanned {
        total_regions: u32,
    },
    RegionNameResolved {
        index: u32,
        total: u32,
    },
    Done,
    Error {
        message: String,
    },
}
Expand description

Serializable view of a MapProgressEvent for the SSE stream.

The MapProgressEvent from sl-map-apis is not Serialize; this DTO translates each variant into a JSON-friendly shape.

Variants§

§

PlanComputed

the rendering plan has been computed.

Fields

§zoom_level: u8

chosen zoom level for the render.

§total_tiles: u32

total number of tiles that will be fetched / processed.

§

TileStarted

processing of a tile has started.

Fields

§zoom: u8

zoom level of the tile.

§x: u32

lower-left x grid coordinate of the tile.

§y: u32

lower-left y grid coordinate of the tile.

§

TileFinished

processing of a tile has finished.

Fields

§zoom: u8

zoom level of the tile.

§x: u32

lower-left x grid coordinate of the tile.

§y: u32

lower-left y grid coordinate of the tile.

§outcome: &'static str

where the tile came from (memory, disk, network, missing).

§

RegionCheckPlanned

the renderer will check per-region existence (triggered by the missing_region_color option). Often slower than the main tile fetch because each check may pull several higher-zoom tiles.

Fields

§total_regions: u32

upper bound on the number of region checks.

§

RegionChecked

a region’s existence has been determined.

Fields

§x: u32

x grid coordinate of the region.

§y: u32

y grid coordinate of the region.

§exists: bool

whether the region exists.

§

RoutePlanned

the route drawing phase has started.

Fields

§total_waypoints: usize

number of waypoints in the route.

§

RouteWaypointResolved

a waypoint in the route has been resolved.

Fields

§index: usize

0-based index of the waypoint.

§total: usize

total number of waypoints.

§region: String

resolved region name.

§

RegionNamesPlanned

resolving region names for the per-region annotation overlay has started.

Fields

§total_regions: u32

number of regions whose names will be resolved.

§

RegionNameResolved

one region’s name has been resolved for the overlay.

Fields

§index: u32

0-based index of the region.

§total: u32

total number of regions whose names will be resolved.

§

Done

the job has finished successfully.

§

Error

the job has finished with an error.

Fields

§message: String

human-readable error message.

Trait Implementations§

Source§

impl Clone for ProgressDto

Source§

fn clone(&self) -> ProgressDto

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 Debug for ProgressDto

Source§

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

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

impl From<MapProgressEvent> for ProgressDto

Source§

fn from(value: MapProgressEvent) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ProgressDto

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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