Struct ByteSerializer

pub struct ByteSerializer { /* private fields */ }

Binary data serializer

Note

• All of these fixups are from the __data__ section.

Trait Implementations

impl Debug for ByteSerializer

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

Formats the value using the given formatter.

impl Default for ByteSerializer

fn default() -> ByteSerializer

Returns the “default value” for a type.

impl SerializeFlags for &mut ByteSerializer

fn serialize_field<T>(&mut self, _key: &str, _value: &T) -> Result<()>

where T: ?Sized + Serialize,

Ignore this method because it is an XML method.

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_bits<T>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize all bits of a flag.(Only used by binary serializer.)

fn end(self) -> Result<Self::Ok>

Finish serializing flags.

fn serialize_empty_bit(&mut self) -> Result<(), Self::Error>

Serialization process when the flag is 0bits.(Only used by XML serializer.)

impl SerializeSeq for &mut ByteSerializer

fn serialize_class_element<T>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

This method is called on HavokClasses array.(Write start)

Therefore, it is necessary to record the write position of this in virtual_fixup.

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_primitive_element<T>( &mut self, value: &T, _index: usize, _len: usize, ) -> Result<(), Self::Error>

where T: ?Sized + Serialize,

Serialize a primitive sequence element. (e.g. char, bool u8..u64, i8..i64, f32, Pointer)

fn serialize_math_element<T>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a math sequence element.(e.g. Matrix3)

fn serialize_cstring_element(&mut self, value: &CString<'_>) -> Result<()>

Serialize a cstring sequence element.

fn serialize_stringptr_element(&mut self, value: &StringPtr<'_>) -> Result<()>

Serialize a stringptr sequence element.

fn end(self) -> Result<()>

Finish serializing a sequence.

impl<'a> Serializer for &'a mut ByteSerializer

fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error>

Assume that the characters are ASCII charactersc_char. In that case, i8 is used to fit into 128 characters.

fn serialize_struct( self, name: &'static str, class_meta: Option<(Pointer, Signature)>, sizes: (u64, u64), ) -> Result<Self::SerializeStruct, Self::Error>

This is called in the Havok Class array or HashMap, or in a serializer in a field. Classes in the field may be inlined, in which case class_meta will be None.

what’s class_meta?

If class_meta exists, it is when writing an hkobject with the name attribute in XML. This must be written to virtual_fixup so that the constructor can be called.

fn serialize_stringptr(self, v: &StringPtr<'_>) -> Result<Self::Ok, Self::Error>

In the binary serialization of hkx, this is the actual data writing process beyond the pointer that is called only after all fields of the structure have been written.

type Ok = ()

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an io::Write or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around.

type Error = Error

The error type when some error occurs during serialization.

type SerializeSeq = &'a mut ByteSerializer

Type returned from serialize_seq for serializing the content of the sequence.

type SerializeStruct = StructSerializer<'a>

type SerializeFlags = &'a mut ByteSerializer

Type returned from serialize_enum_flags for serializing the content of the struct variant.

fn serialize_void(self, _: ()) -> Result<Self::Ok, Self::Error>

Serialize a Void value.

fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error>

Serialize a bool value.

fn serialize_int8(self, v: i8) -> Result<Self::Ok, Self::Error>

Serialize an i8 value.

fn serialize_uint8(self, v: u8) -> Result<Self::Ok, Self::Error>

Serialize an u8 value.

fn serialize_int16(self, v: i16) -> Result<Self::Ok, Self::Error>

Serialize an i16 value.

fn serialize_uint16(self, v: u16) -> Result<Self::Ok, Self::Error>

Serialize an u16 value.

fn serialize_int32(self, v: i32) -> Result<Self::Ok, Self::Error>

Serialize an i32 value.

fn serialize_uint32(self, v: u32) -> Result<Self::Ok, Self::Error>

Serialize an u32 value.

fn serialize_int64(self, v: i64) -> Result<Self::Ok, Self::Error>

Serialize an u64 value.

fn serialize_uint64(self, v: u64) -> Result<Self::Ok, Self::Error>

Serialize an i64 value.

fn serialize_real(self, v: f32) -> Result<Self::Ok, Self::Error>

Serialize an f32 value.

fn serialize_vector4(self, v: &Vector4) -> Result<Self::Ok, Self::Error>

Serialize an Vector4 value.

fn serialize_quaternion(self, v: &Quaternion) -> Result<Self::Ok, Self::Error>

Serialize an Quaternion value.

fn serialize_matrix3(self, v: &Matrix3) -> Result<Self::Ok, Self::Error>

Serialize an Matrix3 value.

fn serialize_rotation(self, v: &Rotation) -> Result<Self::Ok, Self::Error>

Serialize an Rotation value.

fn serialize_matrix4(self, v: &Matrix4) -> Result<Self::Ok, Self::Error>

Serialize an Matrix4 value.

fn serialize_qstransform(self, v: &QsTransform) -> Result<Self::Ok, Self::Error>

Serialize an QsTransform value.

fn serialize_transform(self, v: &Transform) -> Result<Self::Ok, Self::Error>

Serialize an Transform value.

fn serialize_pointer(self, ptr: Pointer) -> Result<Self::Ok, Self::Error>

Serialize an Pointer value.

fn serialize_array( self, _len: Option<usize>, ) -> Result<Self::SerializeSeq, Self::Error>

Serialize an Array value.

fn serialize_variant(self, v: &Variant) -> Result<Self::Ok, Self::Error>

Serialize an Variant value.

fn serialize_cstring(self, v: &CString<'_>) -> Result<Self::Ok, Self::Error>

Serialize an CString value.

fn serialize_ulong(self, v: Ulong) -> Result<Self::Ok, Self::Error>

Serialize an ULong(pointer size(u32 or u64)) value.

fn serialize_enum_flags(self) -> Result<Self::SerializeFlags, Self::Error>

Serialize an enum or Flags value.

fn serialize_half(self, v: f16) -> Result<Self::Ok, Self::Error>

Serialize an Half(f16) value.