Skip to main content

Attribute

Struct Attribute 

Source
pub struct Attribute<T: SdkValue> { /* private fields */ }
Expand description

A typed configuration or gameplay-event attribute descriptor.

T selects the expected SCS tagged-union member and the decoded Rust value. Indexed descriptors represent arrays such as wheel positions or forward gear ratios; callers must select an explicit zero-based index for them.

Implementations§

Source§

impl<T: SdkValue> Attribute<T>

Source

pub const fn new( name: &'static CStr, availability: GameSchemaAvailability, ) -> Self

Creates a scalar attribute descriptor whose SDK index is SCS_U32_NIL.

Source

pub const fn indexed( name: &'static CStr, availability: GameSchemaAvailability, ) -> Self

Creates an attribute descriptor selected by a zero-based SDK index.

Source

pub const fn name(self) -> &'static CStr

Source

pub const fn is_indexed(self) -> bool

Source

pub const fn availability(self) -> GameSchemaAvailability

Official per-game schema history for this attribute.

Source

pub const fn value_type(self) -> ScsValueType

Source

pub const fn erase(self) -> AnyAttribute

Erases the Rust marker type while preserving the complete descriptor metadata required for catalog enumeration.

This does not decode values and does not weaken Attribute::decode. The returned descriptor remains explicit about both the SCS value type and indexed/scalar lookup mode.

Source

pub fn decode(self, value: ValueRef<'_>) -> Option<T::Decoded<'_>>

Decodes one attribute value after verifying its SCS type tag.

Trait Implementations§

Source§

impl<T: SdkValue> Clone for Attribute<T>

Source§

fn clone(&self) -> Self

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: SdkValue> Copy for Attribute<T>

Source§

impl<T: Debug + SdkValue> Debug for Attribute<T>

Source§

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

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

impl<T: Eq + SdkValue> Eq for Attribute<T>

Source§

impl<T: PartialEq + SdkValue> PartialEq for Attribute<T>

Source§

fn eq(&self, other: &Attribute<T>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialEq + SdkValue> StructuralPartialEq for Attribute<T>

Auto Trait Implementations§

§

impl<T> Freeze for Attribute<T>

§

impl<T> RefUnwindSafe for Attribute<T>

§

impl<T> Send for Attribute<T>

§

impl<T> Sync for Attribute<T>

§

impl<T> Unpin for Attribute<T>

§

impl<T> UnsafeUnpin for Attribute<T>

§

impl<T> UnwindSafe for Attribute<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.

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.