mxp 1.2.1

Rust implementation of the MXP (Mud eXtension Protocol) standard
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

use flagset::FlagSet;

use crate::keyword::EntityKeyword;

/// Visibility of an [`Entity`](crate::Entity), as defined by the server.
///
/// See [MXP specification: Entities](https://www.zuggsoft.com/zmud/mxp.htm#ENTITY).
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub enum EntityVisibility {
    /// By default, MXP entities can be queried, but are not listed.
    #[default]
    Default,
    /// Private entities cannot be queried by the MUD client.  They are completely hidden.
    Private,
    /// Published entities can be used by the client to produce a list of MUD Server variables to be access by the player.
    Publish,
}

impl From<FlagSet<EntityKeyword>> for EntityVisibility {
    fn from(value: FlagSet<EntityKeyword>) -> Self {
        if value.contains(EntityKeyword::Private) {
            Self::Private
        } else if value.contains(EntityKeyword::Publish) {
            Self::Publish
        } else {
            Self::Default
        }
    }
}