Struct rivet_identity::client::fluent_builders::PrepareGameLink

pub struct PrepareGameLink<C, M, R = Standard> { /* private fields */ }

Fluent builder constructing a request to PrepareGameLink.

Begins the process for linking an identity with the Rivet Hub. # Importance of Linking Identities When an identity is created via rivet.api.identity#SetupIdentity, the identity is temporary and is not shared with other games the user plays. In order to make the identity permanent and synchronize the identity with other games, the identity must be linked with the hub. # Linking Process The linking process works by opening identity_link_url in a browser then polling rivet.api.identity#GetGameLink to wait for it to complete. This is designed to be as flexible as possible so identity_link_url can be opened on any device. For example, when playing a console game, the user can scan a QR code for identity_link_url to authenticate on their phone.

Implementations

impl<C, M, R> PrepareGameLink<C, M, R>where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy,

pub async fn send(
    self
) -> Result<PrepareGameLinkOutput, SdkError<PrepareGameLinkError>>where
    R::Policy: SmithyRetryPolicy<PrepareGameLinkInputOperationOutputAlias, PrepareGameLinkOutput, PrepareGameLinkError, PrepareGameLinkInputOperationRetryAlias>,

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for PrepareGameLink<C, M, R>

fn clone(&self) -> PrepareGameLink<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for PrepareGameLink<C, M, R>

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

Formats the value using the given formatter.