Skip to main content

Property

Struct Property 

Source
pub struct Property<T> { /* private fields */ }
Expand description

Typed property handle. Wraps a PropertyKey with a phantom T so reads and writes never stringify.

Construct with Self::new (global key) or Self::entity (entity-scoped key). Round-trip through Self::get / Self::set against a PropertyStore borrow.

use lumen_core::prelude::*;
let count: Property<i64> = Property::new("count");
let mut store = PropertyStore::default();
count.set(&mut store, 42);
assert_eq!(count.get(&store), Some(42));

Implementations§

Source§

impl<T> Property<T>

Source

pub fn new(name: impl Into<Arc<str>>) -> Self

Constructs a handle keyed on the global namespace (PropertyKey::Global).

Source

pub fn entity(e: Entity, name: impl Into<Arc<str>>) -> Self

Constructs a handle keyed on the entity-scoped namespace.

Source

pub fn key(&self) -> &PropertyKey

Borrows the underlying PropertyKey. Useful when the caller needs to pass the key into raw PropertyStore APIs.

Source

pub fn get(&self, store: &PropertyStore) -> Option<T>

Reads the typed value from store. Returns None when the key is absent. When the stored cell is a variant T doesn’t natively represent, the conversion falls back to T’s Default-ish coercion (matches the existing From<PropertyValue> for T semantics).

Source

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

Writes value into the cell, bumping the cell’s generation and appending to the dirty queue (subject to PropertyStore::freeze_notify).

Trait Implementations§

Source§

impl<T: Clone> Clone for Property<T>

Source§

fn clone(&self) -> Property<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 Property<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 Property<T>

§

impl<T> RefUnwindSafe for Property<T>

§

impl<T> Send for Property<T>

§

impl<T> Sync for Property<T>

§

impl<T> Unpin for Property<T>

§

impl<T> UnsafeUnpin for Property<T>

§

impl<T> UnwindSafe for Property<T>

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.

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.

§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
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> ConditionalSend for T
where T: Send,