Skip to main content

ConfigurationEvent

Struct ConfigurationEvent 

Source
pub struct ConfigurationEvent<'a> { /* private fields */ }
Expand description

High-level view over one SDK configuration event.

This wrapper keeps the exact zero-allocation typed decoder in scs-sdk while adding Rust-text accessors for product plugins. All borrowed data is still restricted to the current callback.

Implementations§

Source§

impl<'a> ConfigurationEvent<'a>

Source

pub fn is(self, id: ConfigurationId) -> bool

Tests the event against a typed SDK configuration identifier.

Source

pub fn trailer(self) -> Option<TrailerConfigurationId>

Classifies the legacy or numbered trailer configuration identity.

Source

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

Returns the numbered trailer index, excluding the legacy alias.

Source

pub fn is_legacy_trailer(self) -> bool

Whether this is the legacy unnumbered trailer configuration.

Source

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

Configuration identifier as Rust text.

Source

pub fn has_attributes(self) -> bool

Whether the event contains at least one attribute.

SCS sends an empty job configuration when the active job disappears.

Source

pub fn get<T: SdkValue>(self, attribute: Attribute<T>) -> Option<T::Decoded<'a>>

Decodes a scalar typed attribute.

Source

pub fn get_at<T: SdkValue>( self, attribute: Attribute<T>, index: SdkIndex, ) -> Option<T::Decoded<'a>>

Decodes one member of an indexed typed attribute.

Source

pub fn string(self, attribute: Attribute<StringValue>) -> Option<Cow<'a, str>>

Decodes a string attribute as callback-lifetime Rust text.

Source

pub fn string_owned(self, attribute: Attribute<StringValue>) -> Option<String>

Copies a string attribute for storage beyond the current callback.

Source

pub fn shifter_type(self) -> Option<ShifterType>

Decodes the documented controls shifter type as a Rust enum.

None covers an absent attribute and a future string which SDK 1.14 did not document. Call ConfigurationEvent::string with sdk::configuration::attributes::SHIFTER_TYPE when the original unknown text must be retained for forward-compatible diagnostics.

Source

pub fn job_market(self) -> Option<JobMarket>

Decodes the documented active-job market as a Rust enum.

Unknown future values remain accessible through the generic string accessor instead of being reclassified as one of the known SDK 1.14 variants.

Trait Implementations§

Source§

impl<'a> Clone for ConfigurationEvent<'a>

Source§

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

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<'a> Copy for ConfigurationEvent<'a>

Auto Trait Implementations§

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