Struct tw_pack_lib::PFHFlags

pub struct PFHFlags { /* fields omitted */ }

This represents the bitmasks a PackFile can have applied to his type.

The possible bitmasks are:

• HAS_BIG_HEADER: Used to specify that the header of the PackFile is extended by 20 bytes. Used in Arena.
• HAS_ENCRYPTED_INDEX: Used to specify that the PackedFile Index is encrypted. Used in Arena.
• HAS_INDEX_WITH_TIMESTAMPS: Used to specify that the PackedFile Index contains a timestamp of evey PackFile.
• HAS_ENCRYPTED_CONTENT: Used to specify that the PackedFile's data is encrypted. Seen in music.pack PackFiles and in Arena.

Methods

impl PFHFlags

pub const HAS_BIG_HEADER: PFHFlags

HAS_BIG_HEADER: PFHFlags = PFHFlags{bits: 256,}

pub const HAS_ENCRYPTED_INDEX: PFHFlags

HAS_ENCRYPTED_INDEX: PFHFlags = PFHFlags{bits: 128,}

pub const HAS_INDEX_WITH_TIMESTAMPS: PFHFlags

HAS_INDEX_WITH_TIMESTAMPS: PFHFlags = PFHFlags{bits: 64,}

pub const HAS_ENCRYPTED_CONTENT: PFHFlags

HAS_ENCRYPTED_CONTENT: PFHFlags = PFHFlags{bits: 16,}

pub fn empty() -> PFHFlags

Returns an empty set of flags.

pub fn all() -> PFHFlags

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<PFHFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u32) -> PFHFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: PFHFlags) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: PFHFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PFHFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PFHFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PFHFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: PFHFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Copy for PFHFlags

impl PartialEq for PFHFlags

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

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

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

This method tests for !=.

impl Eq for PFHFlags

impl Clone for PFHFlags

fn clone(&self) -> PFHFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for PFHFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Ord for PFHFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for PFHFlags

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,

Feeds a slice of this type into the given [Hasher].

impl Debug for PFHFlags

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

Formats the value using the given formatter.

impl Binary for PFHFlags

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

Formats the value using the given formatter.

impl Octal for PFHFlags

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

Formats the value using the given formatter.

impl LowerHex for PFHFlags

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

Formats the value using the given formatter.

impl UpperHex for PFHFlags

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

Formats the value using the given formatter.

impl BitOr for PFHFlags

type Output = PFHFlags

The resulting type after applying the | operator.

fn bitor(self, other: PFHFlags) -> PFHFlags

Returns the union of the two sets of flags.

impl BitOrAssign for PFHFlags

fn bitor_assign(&mut self, other: PFHFlags)

Adds the set of flags.

impl BitXor for PFHFlags

type Output = PFHFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: PFHFlags) -> PFHFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign for PFHFlags

fn bitxor_assign(&mut self, other: PFHFlags)

Toggles the set of flags.

impl BitAnd for PFHFlags

type Output = PFHFlags

The resulting type after applying the & operator.

fn bitand(self, other: PFHFlags) -> PFHFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign for PFHFlags

fn bitand_assign(&mut self, other: PFHFlags)

Disables all flags disabled in the set.

impl Sub for PFHFlags

type Output = PFHFlags

The resulting type after applying the - operator.

fn sub(self, other: PFHFlags) -> PFHFlags

Returns the set difference of the two sets of flags.

impl SubAssign for PFHFlags

fn sub_assign(&mut self, other: PFHFlags)

Disables all flags enabled in the set.

impl Not for PFHFlags

type Output = PFHFlags

The resulting type after applying the ! operator.

fn not(self) -> PFHFlags

Returns the complement of this set of flags.

impl Extend<PFHFlags> for PFHFlags

fn extend<T: IntoIterator<Item = PFHFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<PFHFlags> for PFHFlags

fn from_iter<T: IntoIterator<Item = PFHFlags>>(iterator: T) -> PFHFlags

Creates a value from an iterator.