Struct ChannelUpdate 

pub struct ChannelUpdate<'a> { /* private fields */ }

One safely borrowed channel callback.

Numeric and geometry values may be copied out and retained. String values borrow storage owned by the game and therefore remain tied to this update’s callback lifetime.

Implementations

impl<'a> ChannelUpdate<'a>

pub const fn channel(self) -> AnyChannel

Type-erased canonical descriptor originally supplied by the plugin.

pub fn registered_name(self) -> Cow<'a, str>

Exact name registered with SCS, including a multi-trailer prefix.

Official channel names are ASCII. The lossy return type also keeps this method total if a future SDK accepts a non-UTF-8 custom channel name.

pub const fn index(self) -> Option<SdkIndex>

Zero-based SDK array index, or None for a scalar channel.

pub const fn trailer_index(self) -> Option<TrailerIndex>

Zero-based trailer number embedded in the registered name.

pub const fn flags(self) -> ChannelFlags

Delivery flags used for this subscription.

pub const fn value_ref(self) -> Option<ValueRef<'a>>

Raw safe view of the tagged value, absent for NO_VALUE subscriptions.

pub fn is<T: ChannelValue>(self, channel: Channel<T>) -> bool

Tests whether this update belongs to a particular typed descriptor.

pub fn value<T: ChannelValue>( self, channel: Channel<T>, ) -> Option<T::Decoded<'a>>

Decodes the update using the supplied typed descriptor.

None means either the descriptor does not match this registration, the subscription requested NO_VALUE, or SCS supplied a different union tag.

Trait Implementations

impl<'a> Clone for ChannelUpdate<'a>

fn clone(&self) -> ChannelUpdate<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ChannelUpdate<'a>