bevy_server_browser 0.5.0

Bevy game engine plugin for creating and searching discoverable servers on local networks
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use std::{
    collections::HashMap,
    fmt::{self, Debug},
};

use mdns_sd::TxtProperties;

/// A string key-value map for additional server info to send to clients.
#[derive(Default, Clone, PartialEq, Eq)]
pub struct ServerMetadata(bevy_utils::HashMap<String, String>);

impl ServerMetadata {
    pub(crate) fn from_txt_properties(props: &TxtProperties) -> ServerMetadata {
        let mut metadata = ServerMetadata::default();

        for property in props.iter() {
            metadata.set(property.key(), property.val_str());
        }

        metadata
    }

    pub(crate) fn into_hash_map(self) -> HashMap<String, String> {
        self.0.into_iter().collect()
    }

    /// Returns new empty server metadata.
    pub fn new() -> Self {
        Default::default()
    }

    /// Returns a reference to the value corresponding to the key.
    pub fn get<K: AsRef<str>>(&self, key: K) -> Option<&str> {
        self.0.get(key.as_ref()).map(|v| v.as_str())
    }

    /// Sets the value of a key.
    pub fn set<K: AsRef<str>, V: ToString>(&mut self, key: K, value: V) {
        self.0.entry_ref(key.as_ref()).insert(value.to_string());
    }

    /// Sets the value of a key and returns self.
    /// This function is useful for chaining metadata creation:
    /// ```
    /// let metadata = ServerMetadata::new()
    ///     .with("key", "value")
    ///     .with("another_key", "another_value")
    ///     .with("answer", 42)
    /// ```
    pub fn with<K: AsRef<str>, V: ToString>(mut self, key: K, value: V) -> Self {
        self.set(key, value);
        self
    }

    /// Iterate over all key-value pairs stored in metadata.
    pub fn iter(&self) -> impl Iterator<Item = (&str, &str)> {
        self.0.iter().map(|(k, v)| (k.as_str(), v.as_str()))
    }
}

impl Debug for ServerMetadata {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_map().entries(&self.0).finish()
    }
}

/// Iterator over server metadata in stable order.
pub struct ServerMetadataIter<'a> {
    inner: bevy_utils::hashbrown::hash_map::Iter<'a, String, String>,
}

impl<'a> Iterator for ServerMetadataIter<'a> {
    type Item = (&'a str, &'a str);

    fn next(&mut self) -> Option<Self::Item> {
        match self.inner.next() {
            Some((k, v)) => Some((k.as_ref(), v.as_ref())),
            None => None,
        }
    }
}

impl<'a> IntoIterator for &'a ServerMetadata {
    type Item = (&'a str, &'a str);
    type IntoIter = ServerMetadataIter<'a>;

    fn into_iter(self) -> Self::IntoIter {
        Self::IntoIter {
            inner: (&self.0).into_iter(),
        }
    }
}