Struct dpmaster_proto::messages::GameName

pub struct GameName(_);

Game name

Contained in a getservers message, getserversExt
and in the Info of an infoResponse message.

Implementations

impl GameName

pub fn new<T: Into<Vec<u8>>>(t: T) -> Result<Self>

Creates a new GameName from a container of bytes.

Game names can contain neither null bytes nor whitespace.

Examples

use dpmaster_proto::GameName;
let game_name = GameName::new(b"Nexuiz".to_vec());
assert!(game_name.is_ok());

Errors

This function will return an error if the supplied bytes contain a null/0 byte or whitespace/' '. The ProtocolError::InvalidGameName error will include the invalid byte as well as the first offset it occurred at.

use dpmaster_proto::{GameName, ProtocolError};
let game_name = GameName::new(b"invalid example".to_vec());
assert_eq!(game_name, Err(ProtocolError::InvalidGameName {byte: b' ', offset: 7}));

Trait Implementations

impl Clone for GameName

fn clone(&self) -> GameName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameName

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

Formats the value using the given formatter.

impl FromStr for GameName

type Err = ProtocolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl<I: SliceIndex<[u8]>> Index<I> for GameName

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq<GameName> for GameName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for GameName

impl StructuralEq for GameName

impl StructuralPartialEq for GameName