Skip to main content

SyncedValue

Struct SyncedValue 

Source
pub struct SyncedValue<T> {
    value: T,
    default: T,
    dirty: bool,
}
Expand description

Wrapper that tracks modifications per-field.

Each field in an entity data struct is wrapped in SyncedValue to track whether it has been modified and needs to be synced to clients.

Fields§

§value: T§default: T§dirty: bool

Implementations§

Source§

impl<T: Clone + PartialEq> SyncedValue<T>

Source

pub fn new(default: T) -> Self

Create a new synced value with the given default.

Source

pub fn get(&self) -> &T

Get a reference to the current value.

Source

pub fn set(&mut self, value: T)

Set the value. Only marks as dirty if the value actually changed.

Source

pub fn is_dirty(&self) -> bool

Returns true if the value has been modified since last sync.

Source

pub fn clear_dirty(&mut self)

Clear the dirty flag after syncing.

Source

pub fn is_default(&self) -> bool

Returns true if the current value equals the default.

Trait Implementations§

Source§

impl<T: Clone> Clone for SyncedValue<T>

Source§

fn clone(&self) -> SyncedValue<T>

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<T: Debug> Debug for SyncedValue<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for SyncedValue<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for SyncedValue<T>
where T: RefUnwindSafe,

§

impl<T> Send for SyncedValue<T>
where T: Send,

§

impl<T> Sync for SyncedValue<T>
where T: Sync,

§

impl<T> Unpin for SyncedValue<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SyncedValue<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for SyncedValue<T>
where T: 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> 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more