Skip to main content

Platform

eos_rs

Struct Platform 

Source 
pub struct Platform(/* private fields */);

Implementations§

Source§

impl Platform

Source

pub fn create(opts: PlatformOptions) -> Result<Self>

Examples found in repository?
examples/platform_minimal.rs (lines 15-25)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn tick(&self)

Examples found in repository?
examples/platform_minimal.rs (line 28)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn raw_handle(&self) -> EOS_HPlatform

Source

pub fn auth(&self) -> Auth

Examples found in repository?
examples/platform_minimal.rs (line 31)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn connect(&self) -> Connect

Examples found in repository?
examples/platform_minimal.rs (line 32)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn achievements(&self) -> Achievements

Source

pub fn anticheat_client(&self) -> AntiCheatClient

Source

pub fn anticheat_server(&self) -> AntiCheatServer

Source

pub fn custom_invites(&self) -> CustomInvites

Source

pub fn ecom(&self) -> Ecom

Source

pub fn friends(&self) -> Friends

Source

pub fn integrated_platform(&self) -> IntegratedPlatform

Source

pub fn kws(&self) -> Kws

Source

pub fn leaderboards(&self) -> Leaderboards

Source

pub fn lobby(&self) -> Lobby

Examples found in repository?
examples/platform_minimal.rs (line 33)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn metrics(&self) -> Metrics

Source

pub fn mods(&self) -> Mods

Source

pub fn p2p(&self) -> P2P

Examples found in repository?
examples/platform_minimal.rs (line 34)
9fn main() -> Result<(), Box<dyn std::error::Error>> {
10    initialize(InitializeOptions {
11        product_name: "eos-rs-example".to_string(),
12        product_version: "0.1.0".to_string(),
13    })?;
14
15    let platform = Platform::create(PlatformOptions {
16        product_id: required_env("EOS_PRODUCT_ID")?,
17        sandbox_id: required_env("EOS_SANDBOX_ID")?,
18        deployment_id: required_env("EOS_DEPLOYMENT_ID")?,
19        client_id: required_env("EOS_CLIENT_ID")?,
20        client_secret: required_env("EOS_CLIENT_SECRET")?,
21        is_server: false,
22        encryption_key: None,
23        override_country_code: None,
24        override_locale_code: None,
25    })?;
26
27    // In a real application, call this from your main loop.
28    platform.tick();
29
30    // Optional: access low-level handles for APIs not yet wrapped.
31    let _auth = platform.auth().raw_handle();
32    let _connect = platform.connect().raw_handle();
33    let _lobby = platform.lobby().raw_handle();
34    let _p2p = platform.p2p().raw_handle();
35
36    drop(platform);
37    shutdown()?;
38    println!("eos-rs minimal flow completed.");
39    Ok(())
40}
Source

pub fn player_data_storage(&self) -> PlayerDataStorage

Source

pub fn presence(&self) -> Presence

Source

pub fn progressionsnapshot(&self) -> ProgressionSnapshot

Source

pub fn reports(&self) -> Reports

Source

pub fn rtc(&self) -> Rtc

Source

pub fn rtc_admin(&self) -> RtcAdmin

Source

pub fn sanctions(&self) -> Sanctions

Source

pub fn sessions(&self) -> Sessions

Source

pub fn stats(&self) -> Stats

Source

pub fn title_storage(&self) -> TitleStorage

Source

pub fn ui(&self) -> Ui

Source

pub fn userinfo(&self) -> UserInfo

Trait Implementations§

Source§

impl Drop for Platform

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Platform

Source§

impl Sync for Platform

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