Struct ZoneRegistry 

pub struct ZoneRegistry<T: Clone + 'static> { /* private fields */ }

Registry of the currently registered drop zones, in registration order.

Implementations

impl<T: Clone + 'static> ZoneRegistry<T>

pub fn from_signal(zones: Signal<Vec<ZoneRecord<T>>>) -> Self

Wrap an existing signal. Prefer crate::core::hooks::use_dnd_provider.

pub fn release_policy(&self) -> ReleasePolicy<T>

Current collision and release policy.

pub fn set_release_policy(&mut self, policy: ReleasePolicy<T>)

Synchronize the provider’s collision and release policy.

pub fn direction(&self) -> Direction

Layout direction spatial ordering follows.

pub fn set_direction(&mut self, dir: Direction)

Set the layout direction (no-op if unchanged; safe to call every render). DndProvider’s dir prop calls this for you.

pub fn register(&mut self, record: ZoneRecord<T>) -> ZoneRegistration

Add (or replace, by id) a zone.

pub fn sync_label(&mut self, id: ZoneId, label: Option<String>)

Update a zone’s label in place (no-op if unchanged or unknown).

pub fn unregister(&mut self, id: ZoneId)

Remove a zone (call when its component unmounts).

pub fn unregister_registration(&mut self, registration: ZoneRegistration)

Remove this exact registration if it is still current.

A keyed Dioxus replacement may mount a new record with the same id before the old component’s cleanup runs. Token-aware cleanup prevents that stale cleanup from deleting the replacement.

pub fn set_mounted( &mut self, registration: ZoneRegistration, mounted: Rc<MountedData>, )

Attach the mounted element to this exact registration. A stale registration token is ignored.

pub fn set_rect_if_present( &mut self, registration: ZoneRegistration, rect: Rect, )

Store a rect only while the registration that requested it is still current. This never inserts a missing zone and therefore cannot resurrect one that unmounted during an async measurement.

pub fn set_rect(&mut self, id: ZoneId, rect: Rect)

Set geometry for the current registration of id. This is the synchronous/manual counterpart to Self::set_rect_if_present, used by custom layout adapters and the headless test driver.

pub fn get(&self, id: ZoneId) -> Option<ZoneRecord<T>>

Look up a zone by id.

pub fn cached_rect(&self, id: ZoneId) -> Option<Rect>

The zone’s cached client rect, read without subscribing. Returns None when unmeasured, unknown, or the provider is already gone.

pub fn mounted_handle(&self, id: ZoneId) -> Option<Rc<MountedData>>

The zone’s mounted element, read without subscribing. Returns None before mount, for an unknown zone, or after provider teardown.

pub fn records(&self) -> Vec<ZoneRecord<T>>

Every registered zone, in registration order. Unlike the peeking lookups around it this is a subscribing read - a component rendering from it re-renders when zones mount or unmount - because its consumers (the debug overlay, your own devtools) are renderers.

pub fn contains(&self, id: ZoneId) -> bool

Is a zone with this id registered here? The parent-zone context is shared across payload types, so a record’s parent can name a zone living in another type’s registry - check before navigating to one.

pub fn ascend(&self, current: ZoneId) -> Option<ZoneId>

The zone keyboard navigation should enter when ascending from current: its parent, but only when that parent is registered in this registry. A DropZone<A> nested inside a DropZone<B> records B’s id as its parent, and entering an id this registry can’t resolve would leave the drag hovering a zone that can never receive it.

pub fn acceptable(&self, payload: &T) -> Vec<ZoneRecord<T>>

All zones accepting payload, in registration order.

pub fn acceptable_query(&self, query: &DropQuery<T>) -> Vec<ZoneRecord<T>>

All zones accepting a complete drop query.

pub fn step_zone( &self, current: Option<ZoneId>, payload: &T, step: isize, ) -> Option<ZoneId>

The next/previous zone (cyclic) relative to current among zones that accept payload. step is +1 or -1.

Order is spatial (top-to-bottom, then left-to-right) for zones with measured rects; tops within one CSS pixel form a row so sub-pixel layout jitter cannot override horizontal reading order. Call Self::refresh_rects first, as the built-in keyboard interaction does on pickup. Unmeasured zones keep registration order afterwards.

pub fn step_zone_query( &self, current: Option<ZoneId>, query: &DropQuery<T>, step: isize, ) -> Option<ZoneId>

pub fn parent_of(&self, id: ZoneId) -> Option<ZoneId>

The parent of a zone, if it’s nested.

pub fn children_of( &self, parent: Option<ZoneId>, payload: &T, ) -> Vec<ZoneRecord<T>>

Zones directly inside parent (None = root level) that accept payload, in spatial order (top-to-bottom, then left-to-right within a one-CSS-pixel row band; unmeasured zones keep registration order at the end).

pub fn children_of_query( &self, parent: Option<ZoneId>, query: &DropQuery<T>, ) -> Vec<ZoneRecord<T>>

pub fn step_sibling( &self, current: Option<ZoneId>, payload: &T, step: isize, ) -> Option<ZoneId>

Next/previous zone (cyclic) among the siblings of current - zones sharing its parent. With no current, cycles the root level.

pub fn step_sibling_query( &self, current: Option<ZoneId>, query: &DropQuery<T>, step: isize, ) -> Option<ZoneId>

pub fn first_child(&self, id: ZoneId, payload: &T) -> Option<ZoneId>

The first (spatially) acceptable zone nested inside id.

pub fn first_child_query( &self, id: ZoneId, query: &DropQuery<T>, ) -> Option<ZoneId>

pub fn hit_test(&self, point: Point) -> Option<ZoneId>

Last record in registry order containing point (client coordinates), using cached rects - call Self::refresh_rects when a drag starts. This only approximates DOM paint order; CSS stacking and portals are not inspected. Replacing a same-id record retains its existing slot.

pub fn hit_test_closest( &self, point: Point, payload: &T, max_distance: f64, ) -> Option<ZoneId>

Like Self::hit_test, but acceptance-aware: it returns the last record in registry order that both contains the point and accepts payload, and when no such zone contains the point, falls back to the acceptable zone whose rect is nearest - within max_distance CSS px of its closest edge, not its center, so a large zone snaps a release right beside it even though its center sits far away. Skipping zones that reject the payload lets a drop land on an earlier accepting overlap, and is friendlier for imprecise (touch) drops that land in the gutter between zones.

pub fn resolve( &self, query: &DropQuery<T>, point: Point, active_rect: Option<Rect>, max_distance: f64, ) -> Option<(ZoneId, DropEffect)>

Resolve a target with this registry’s collision policy and return the target-negotiated effect. Candidates are filtered by the full query before collision ranking, so hover and release share acceptance.

pub fn resolve_hover( &self, query: &DropQuery<T>, point: Point, active_rect: Option<Rect>, current: Option<ZoneId>, ) -> Option<(ZoneId, DropEffect)>

Resolve live hover with optional sticky retention. Exact collisions always win. On an exact miss, a sticky policy may retain only the current acceptable target while the pointer remains inside its recovery radius.

pub async fn measure_all(&self)

Re-measure every mounted zone’s client rect and wait for the measurements to land - unlike Self::refresh_rects, which fires and forgets. Use before a hit-test that must see fresh geometry (e.g. retrying a missed touch drop after a layout change).

pub fn refresh_rects(&self)

Re-measure every mounted zone’s client rect (async, spawned).

Trait Implementations

impl<T: Clone + 'static> Clone for ZoneRegistry<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + 'static> Copy for ZoneRegistry<T>

impl<T: Clone + 'static> PartialEq for ZoneRegistry<T>

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

Equality operator ==.

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

Inequality operator !=.