archipelago_rs 1.0.0

A Rust client for the archipelago.gg multiworld randomizer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use std::sync::Arc;

use serde::de::DeserializeOwned;
use ustr::Ustr;

use crate::{Client, Iter, Player, protocol::*};

/// A group of players playing the same game.
///
/// Currently this is only used for item link groups.
pub struct Group {
    name: Ustr,
    game: Ustr,
    members: Vec<Arc<Player>>,
}

impl Group {
    /// Creates a group by filling in the players from [client].
    ///
    /// We have to do this each time a group is accessed because the client's
    /// name could have been replaced, which we handle by updating the entire
    /// client struct.
    pub(crate) fn hydrate<S: DeserializeOwned>(
        network: &NetworkSlot,
        team: u32,
        client: &Client<S>,
    ) -> Self {
        assert_eq!(network.r#type, SlotType::Group);
        Group {
            name: network.name,
            game: network.game,
            members: network
                .group_members
                .iter()
                .map(|p| client.player_arc(team, *p).unwrap())
                .collect(),
        }
    }

    /// The group name.
    pub fn name(&self) -> Ustr {
        self.name
    }

    /// The game being played by all group members.
    pub fn game(&self) -> Ustr {
        self.game
    }

    /// The members of the group.
    pub fn members(&self) -> impl Iter<&Player> {
        self.members.iter().map(|p| p.as_ref())
    }
}