Skip to main content

PluginCompatibility

Struct PluginCompatibility 

Source
pub struct PluginCompatibility { /* private fields */ }
Expand description

Explicit runtime requirements declared by one product plugin.

The framework and product answer different compatibility questions:

  • scs-sdk decides which foreign API layouts it can decode soundly;
  • this declaration states which decoded API and game capabilities the product actually needs;
  • SCS chooses the concrete API version by calling the exported initializer from newest to oldest.

Ordinary users therefore install one plugin binary and never select an SDK distribution or ABI version manually.

Implementations§

Source§

impl PluginCompatibility

Source

pub const fn new( minimum_telemetry_api: TelemetryApiVersion, games: &'static [GameCompatibility], ) -> Self

Creates an explicit product compatibility declaration.

The games slice must contain at least one recognized game, must not contain duplicate game entries, and must not use Game::Other. These invariants are checked before product initialization so a malformed declaration never reaches SDK registration.

Source

pub const fn minimum_telemetry_api(self) -> TelemetryApiVersion

Oldest Telemetry API whose capabilities the product requires.

Source

pub const fn games(self) -> &'static [GameCompatibility]

Per-game schema requirements accepted by the product.

Trait Implementations§

Source§

impl Clone for PluginCompatibility

Source§

fn clone(&self) -> PluginCompatibility

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 Copy for PluginCompatibility

Source§

impl Debug for PluginCompatibility

Source§

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

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

impl Eq for PluginCompatibility

Source§

impl PartialEq for PluginCompatibility

Source§

fn eq(&self, other: &PluginCompatibility) -> bool

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PluginCompatibility

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.