Struct CountryTag

pub struct CountryTag(/* private fields */);

Wrapper around a Country’s unique three byte tag

use hoi4save::CountryTag;
let tag: CountryTag = "ENG".parse()?;
assert_eq!(tag.to_string(), String::from("ENG"));

Implementations

impl CountryTag

pub fn create<T: AsRef<[u8]>>(s: T) -> Result<Self, Hoi4Error>

Create a country tag from a byte slice. Returns error if input is not three bytes in length and not compose of dashes or alphanumeric data.

use hoi4save::CountryTag;
let tag: CountryTag = CountryTag::create(b"ENG")?;

pub fn is<T: AsRef<[u8]>>(&self, s: T) -> bool

An ergonomic shortcut to determine if input byte slice contains the same data as the tag

use hoi4save::CountryTag;
let tag: CountryTag = CountryTag::create(b"ENG")?;
assert!(tag.is(b"ENG"));

pub fn as_bytes(&self) -> &[u8]

Returns the country tag as a byte slice

use hoi4save::CountryTag;
let tag: CountryTag = CountryTag::create(b"ENG")?;
assert_eq!(tag.as_bytes(), b"ENG");

pub fn as_str(&self) -> &str

Returns the country tag as a string slice

use hoi4save::CountryTag;
let tag: CountryTag = CountryTag::create(b"ENG")?;
assert_eq!(tag.as_str(), "ENG");

Trait Implementations

impl AsRef<str> for CountryTag

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CountryTag

fn clone(&self) -> CountryTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CountryTag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CountryTag

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CountryTag

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

Formats the value using the given formatter.

impl FromStr for CountryTag

type Err = Hoi4Error

The associated error which can be returned from parsing.

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

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

impl Hash for CountryTag

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CountryTag

fn cmp(&self, other: &CountryTag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CountryTag

fn eq(&self, other: &CountryTag) -> 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 PartialOrd for CountryTag

fn partial_cmp(&self, other: &CountryTag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CountryTag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CountryTag

impl Eq for CountryTag

impl StructuralPartialEq for CountryTag