Skip to main content

UserPriorityState

Struct UserPriorityState 

Source
pub struct UserPriorityState<E: Copy + Eq + Hash> { /* private fields */ }
Expand description

Per-connection priority layer. One instance lives on each user Connection (and on the client’s single Connection). Entries are evicted on scope exit for that user.

Implementations§

Source§

impl<E: Copy + Eq + Hash> UserPriorityState<E>

Source

pub fn new() -> Self

Creates an empty UserPriorityState.

Source

pub fn get_ref(&self, entity: E) -> EntityPriorityRef<'_, E>

Returns a read-only priority handle for entity in this user’s layer.

Source

pub fn get_mut(&mut self, entity: E) -> EntityPriorityMut<'_, E>

Returns a mutable priority handle for entity in this user’s layer.

Source

pub fn on_scope_exit(&mut self, entity: &E)

Evict this entity’s per-user entry. Called on scope exit or connection drop.

Source

pub fn gain_override(&self, entity: &E) -> Option<f32>

Read-only gain lookup for this user layer.

Source

pub fn advance(&mut self, entity: E, gain: f32) -> f32

Per-tick advance hook used by the send-side k-way merge. Adds gain to the entity’s accumulator (lazy-creating the entry) and returns the new accumulated value.

This is the canonical “accumulator += effective_gain per tick” rule from PRIORITY_ACCUMULATOR_PLAN.md III.7.1.

Source

pub fn accumulated(&self, entity: &E) -> f32

Read accumulator without advancing.

Source

pub fn reset_after_send(&mut self, entity: &E, current_tick: u32)

Reset the accumulator to 0 and stamp last_sent_tick. Called for each entity whose update bundle fully drained in the current send cycle — the canonical reset-on-send rule from III.7.5.

Trait Implementations§

Source§

impl<E: Copy + Eq + Hash> Default for UserPriorityState<E>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<E> Freeze for UserPriorityState<E>

§

impl<E> RefUnwindSafe for UserPriorityState<E>
where E: RefUnwindSafe,

§

impl<E> Send for UserPriorityState<E>
where E: Send,

§

impl<E> Sync for UserPriorityState<E>
where E: Sync,

§

impl<E> Unpin for UserPriorityState<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for UserPriorityState<E>

§

impl<E> UnwindSafe for UserPriorityState<E>
where E: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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