Struct Vis 

pub struct Vis { /* private fields */ }

In-memory VIS graph.

Implementations

impl Vis

pub fn new() -> Self

Creates an empty VIS graph.

pub fn all_rooms(&self) -> BTreeSet<String>

Returns all known rooms.

pub fn visibility(&self) -> &BTreeMap<String, BTreeSet<String>>

Returns visibility edges keyed by observer room.

pub fn room_exists(&self, room: &str) -> bool

Returns true if room exists in the graph.

pub fn add_room(&mut self, room: impl AsRef<str>)

Adds a room if it does not already exist.

pub fn remove_room(&mut self, room: &str)

Removes a room and all references to it.

pub fn rename_room(&mut self, old: &str, new: &str) -> Result<(), VisError>

Renames a room and updates all references to it.

Errors

VisError::MissingRoom when old names no room, carrying the name. Nothing is renamed in that case. new is not checked for whitespace, which the grammar cannot represent; the writer refuses that instead.

pub fn set_visible( &mut self, when_inside: &str, show: &str, visible: bool, ) -> Result<(), VisError>

Sets visibility between two rooms.

Errors

VisError::MissingRoom when either name is not a room in the graph, carrying the one that is missing. Visibility is directional, so both have to exist and only the named direction changes.

pub fn get_visible( &self, when_inside: &str, show: &str, ) -> Result<bool, VisError>

Returns whether one room is visible from another.

Errors

VisError::MissingRoom when when_inside names no room. A show that is not visible from it is Ok(false) rather than an error, so this distinguishes “not visible” from “not a room”.

pub fn set_all_visible(&mut self)

Marks all rooms visible from each other (excluding self-visibility).

Trait Implementations

impl Clone for Vis

fn clone(&self) -> Vis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vis

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

Formats the value using the given formatter.

impl DecodeBinary for Vis

type Error = VisError

Error type used by the format.

fn decode_binary(bytes: &[u8]) -> Result<Self, Self::Error>

Decodes a value from raw bytes.

impl Default for Vis

fn default() -> Vis

Returns the “default value” for a type.

impl EncodeBinary for Vis

type Error = VisError

Error type used by the format.

fn encode_binary(&self) -> Result<Vec<u8>, Self::Error>

Encodes a value into an owned byte buffer.

impl PartialEq for Vis

fn eq(&self, other: &Vis) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Vis

impl StructuralPartialEq for Vis