Struct ClientWrapper 

pub struct ClientWrapper { /* private fields */ }

A wrapper around Client. Helps reduce external imports.

Methods from Deref<Target = Client<DynConnector, Identity>>

pub fn conf(&self) -> &Config

Returns the client’s configuration.

pub fn create_party(&self) -> CreateParty<C, M, R>

Constructs a fluent builder for the CreateParty operation.

• The fluent builder is configurable:
  • party_size(i32) / set_party_size(Option<i32>): How many members can join the party. If using this party with the matchmaker, this number should be less than or equal to your party player limit. Super large parties may not be able to fit insite a lobby and be unable to join the game.
  • publicity(CreatePartyPublicityConfig) / set_publicity(Option<CreatePartyPublicityConfig>): Publicity configuration for creating a party. Null values will default
  • invites(Vec<CreatePartyInviteConfig>) / set_invites(Option<Vec<CreatePartyInviteConfig>>): (undocumented)
  • matchmaker_current_player_token(impl Into<String>) / set_matchmaker_current_player_token(Option<String>): If the player is currently in the lobby, pass the token from rivet.matchmaker#MatchmakerLobbyJoinInfoPlayer$token. This will prevent issuing a new player token and automatically set the party state to the player’s current lobby.
• On success, responds with CreatePartyOutput with field(s):
  • party_id(Option<String>): A universally unique identifier.
  • invites(Option<Vec<CreatedInvite>>): (undocumented)
• On failure, responds with SdkError<CreatePartyError>

pub fn create_party_invite(&self) -> CreatePartyInvite<C, M, R>

Constructs a fluent builder for the CreatePartyInvite operation.

• The fluent builder is configurable:
  • alias(impl Into<String>) / set_alias(Option<String>): An alias used to join a given party.
• On success, responds with CreatePartyInviteOutput with field(s):
  • invite(Option<CreatedInvite>): Output from a created invite.
• On failure, responds with SdkError<CreatePartyInviteError>

pub fn get_party_from_invite(&self) -> GetPartyFromInvite<C, M, R>

Constructs a fluent builder for the GetPartyFromInvite operation.

• The fluent builder is configurable:
  • token(impl Into<String>) / set_token(Option<String>): See rivet.api.party#CreatedInvite$token.
  • alias(impl Into<String>) / set_alias(Option<String>): An alias used to join a given party. This alias must be unique for all invites for your game. Pass this alias to rivet.api.party.common#CreatedInvite$alias to consume the invite.
• On success, responds with GetPartyFromInviteOutput with field(s):
  • party(Option<PartySummary>): A party summary.
• On failure, responds with SdkError<GetPartyFromInviteError>

pub fn get_party_profile(&self) -> GetPartyProfile<C, M, R>

Constructs a fluent builder for the GetPartyProfile operation.

• The fluent builder is configurable:
  • party_id(impl Into<String>) / set_party_id(Option<String>): A universally unique identifier.
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with GetPartyProfileOutput with field(s):
  • party(Option<PartyProfile>): (undocumented)
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<GetPartyProfileError>

pub fn get_party_self_profile(&self) -> GetPartySelfProfile<C, M, R>

Constructs a fluent builder for the GetPartySelfProfile operation.

• The fluent builder is configurable:
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with GetPartySelfProfileOutput with field(s):
  • party(Option<PartyProfile>): (undocumented)
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<GetPartySelfProfileError>

pub fn get_party_self_summary(&self) -> GetPartySelfSummary<C, M, R>

Constructs a fluent builder for the GetPartySelfSummary operation.

• The fluent builder is configurable:
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with GetPartySelfSummaryOutput with field(s):
  • party(Option<PartySummary>): A party summary.
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<GetPartySelfSummaryError>

pub fn get_party_summary(&self) -> GetPartySummary<C, M, R>

Constructs a fluent builder for the GetPartySummary operation.

• The fluent builder is configurable:
  • party_id(impl Into<String>) / set_party_id(Option<String>): A universally unique identifier.
  • watch_index(impl Into<String>) / set_watch_index(Option<String>): A query parameter denoting the requests watch index.
• On success, responds with GetPartySummaryOutput with field(s):
  • party(Option<PartySummary>): A party summary.
  • watch(Option<WatchResponse>): Provided by watchable endpoints used in blocking loops.
• On failure, responds with SdkError<GetPartySummaryError>

pub fn join_party(&self) -> JoinParty<C, M, R>

Constructs a fluent builder for the JoinParty operation.

• The fluent builder is configurable:
  • invite(JoinPartyInvite) / set_invite(Option<JoinPartyInvite>): Represents methods of joining a party.
  • matchmaker_auto_join_lobby(bool) / set_matchmaker_auto_join_lobby(Option<bool>): Whether or not to automatically join the game lobby if a party is currently in game.
• On success, responds with JoinPartyOutput with field(s):
  • party_id(Option<String>): A universally unique identifier.
• On failure, responds with SdkError<JoinPartyError>

pub fn kick_member(&self) -> KickMember<C, M, R>

Constructs a fluent builder for the KickMember operation.

• The fluent builder is configurable:
  • identity_id(impl Into<String>) / set_identity_id(Option<String>): A universally unique identifier.
• On success, responds with KickMemberOutput
• On failure, responds with SdkError<KickMemberError>

pub fn leave_party(&self) -> LeaveParty<C, M, R>

Constructs a fluent builder for the LeaveParty operation.

• The fluent builder takes no input, just send it.
• On success, responds with LeavePartyOutput
• On failure, responds with SdkError<LeavePartyError>

pub fn revoke_party_invite(&self) -> RevokePartyInvite<C, M, R>

Constructs a fluent builder for the RevokePartyInvite operation.

• The fluent builder is configurable:
  • invite_id(impl Into<String>) / set_invite_id(Option<String>): A universally unique identifier.
• On success, responds with RevokePartyInviteOutput
• On failure, responds with SdkError<RevokePartyInviteError>

pub fn send_join_request(&self) -> SendJoinRequest<C, M, R>

Constructs a fluent builder for the SendJoinRequest operation.

• The fluent builder is configurable:
  • party_id(impl Into<String>) / set_party_id(Option<String>): A universally unique identifier.
• On success, responds with SendJoinRequestOutput
• On failure, responds with SdkError<SendJoinRequestError>

pub fn set_party_publicity(&self) -> SetPartyPublicity<C, M, R>

Constructs a fluent builder for the SetPartyPublicity operation.

• The fluent builder is configurable:
  • public(PartyPublicityLevel) / set_public(Option<PartyPublicityLevel>): Defaults to rivet.party#PartyPublicityLevel$VIEW.
  • mutual_followers(PartyPublicityLevel) / set_mutual_followers(Option<PartyPublicityLevel>): Defaults to rivet.party#PartyPublicityLevel$JOIN.
  • groups(PartyPublicityLevel) / set_groups(Option<PartyPublicityLevel>): Defaults to rivet.party#PartyPublicityLevel$VIEW.
• On success, responds with SetPartyPublicityOutput
• On failure, responds with SdkError<SetPartyPublicityError>

pub fn transfer_party_ownership(&self) -> TransferPartyOwnership<C, M, R>

Constructs a fluent builder for the TransferPartyOwnership operation.

• The fluent builder is configurable:
  • identity_id(impl Into<String>) / set_identity_id(Option<String>): A universally unique identifier.
• On success, responds with TransferPartyOwnershipOutput
• On failure, responds with SdkError<TransferPartyOwnershipError>

pub fn find_matchmaker_lobby_for_party( &self, ) -> FindMatchmakerLobbyForParty<C, M, R>

Constructs a fluent builder for the FindMatchmakerLobbyForParty operation.

• The fluent builder is configurable:
  • game_modes(Vec<String>) / set_game_modes(Option<Vec<String>>): Game modes to match lobbies against.
  • regions(Vec<String>) / set_regions(Option<Vec<String>>): Regions to match lobbies against. If not specified, the optimal region will be determined and will attempt to find lobbies in that region.
  • prevent_auto_create_lobby(bool) / set_prevent_auto_create_lobby(Option<bool>): Prevents a new lobby from being created when finding a lobby. If no lobby is found, MATCHMAKER_LOBBY_NOT_FOUND will be returned.
  • origin(impl Into<String>) / set_origin(Option<String>): (undocumented)
• On success, responds with FindMatchmakerLobbyForPartyOutput
• On failure, responds with SdkError<FindMatchmakerLobbyForPartyError>

pub fn join_matchmaker_lobby_for_party( &self, ) -> JoinMatchmakerLobbyForParty<C, M, R>

Constructs a fluent builder for the JoinMatchmakerLobbyForParty operation.

• The fluent builder is configurable:
  • lobby_id(impl Into<String>) / set_lobby_id(Option<String>): A universally unique identifier.
• On success, responds with JoinMatchmakerLobbyForPartyOutput
• On failure, responds with SdkError<JoinMatchmakerLobbyForPartyError>

pub fn request_matchmaker_player(&self) -> RequestMatchmakerPlayer<C, M, R>

Constructs a fluent builder for the RequestMatchmakerPlayer operation.

• The fluent builder takes no input, just send it.
• On success, responds with RequestMatchmakerPlayerOutput
• On failure, responds with SdkError<RequestMatchmakerPlayerError>

pub fn set_party_to_idle(&self) -> SetPartyToIdle<C, M, R>

Constructs a fluent builder for the SetPartyToIdle operation.

• The fluent builder takes no input, just send it.
• On success, responds with SetPartyToIdleOutput
• On failure, responds with SdkError<SetPartyToIdleError>

Trait Implementations

impl Deref for ClientWrapper

type Target = Client<DynConnector, Identity>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.