Struct s2protocol::init_data::InitData

pub struct InitData {
    pub sync_lobby_state: LobbySyncState,
    pub sha256: String,
    pub file_name: String,
    pub version: u32,
}

Fields

sync_lobby_state: LobbySyncState

The lobby state

sha256: String

The sha256 of the file, prevent duplicates and provide a unique identifier

file_name: String

The file name

version: u32

The version of the protocol

Implementations

impl InitData

pub fn new( file_name: &str, mpq: &MPQ, file_contents: &[u8] ) -> Result<Self, S2ProtocolError>

Calls the per-protocol parser for the InitData and sets the metadadata.

pub fn set_metadata(self, file_name: &str, file_contents: &[u8]) -> Self

pub fn set_version(&mut self, version: u32)

pub fn trim_sha(&mut self, n: usize)

Trim the sha to n characters, this is done to reduce the size of the generated files because every sha is unique and we don’t need the full sha to identify the file.

Trait Implementations

impl ArrowDeserialize for InitData

type ArrayType = InitDataArray

The arrow2::Array type corresponding to this field

fn arrow_deserialize<'a>(v: Option<Self>) -> Option<Self>

Deserialize this field from arrow

impl ArrowField for InitData

type Type = InitData

This should be Self except when implementing large offset and fixed placeholder types. For the later, it should refer to the actual type. For example when the placeholder type is LargeString, this should be String.

fn data_type() -> DataType

The DataType

impl ArrowSerialize for InitData

type MutableArrayType = MutableInitDataArray

The arrow2::array::MutableArray that holds this value

fn new_array() -> Self::MutableArrayType

Create a new mutable array

fn arrow_serialize(v: &Self, array: &mut Self::MutableArrayType) -> Result<()>

Serialize this field to arrow

impl Clone for InitData

fn clone(&self) -> InitData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InitData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InitData

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PathBuf> for InitData

fn try_from(path: PathBuf) -> Result<Self, Self::Error>

Reads the file from the path and calls the per-protocol parser for the InitData. Sets the metadata if successful. Returns an error if the file cannot be read or the parser fails.

type Error = S2ProtocolError

The type returned in the event of a conversion error.

impl TryFrom<ReplaySInitData> for InitData

type Error = S2ProtocolError

The type returned in the event of a conversion error.

fn try_from(source: ReplaySInitData) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for InitData