Trait xc3_write::Xc3Write

pub trait Xc3Write {
    type Offsets<'a>
       where Self: 'a;

    const ALIGNMENT: u64 = 4u64;

    // Required method
    fn xc3_write<W: Write + Seek>(
        &self,
        writer: &mut W,
        data_ptr: &mut u64
    ) -> Xc3Result<Self::Offsets<'_>>;

    // Provided method
    fn should_write(&self) -> Option<bool> { ... }
}

The write pass that writes fields and placeholder offsets.

Required Associated Types

type Offsets<'a> where Self: 'a

The type storing offset data to be used in Xc3WriteOffsets.

Provided Associated Constants

const ALIGNMENT: u64 = 4u64

The alignment of absolute offsets for this type in bytes.

Required Methods

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

Write all fields and placeholder offsets and set data_ptr to the position after writing. This should almost always be derived for non primitive types.

Provided Methods

fn should_write(&self) -> Option<bool>

Return true if this type has no data and should not be written.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Xc3Write for f32

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 4u64

impl Xc3Write for i8

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 1u64

impl Xc3Write for i16

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 2u64

impl Xc3Write for i32

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 4u64

impl Xc3Write for i64

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 4u64

impl Xc3Write for u8

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 1u64

impl Xc3Write for u16

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 2u64

impl Xc3Write for u32

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 4u64

impl Xc3Write for u64

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 4u64

impl Xc3Write for ()

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, _writer: &mut W, _data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 1u64

impl Xc3Write for String

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

const ALIGNMENT: u64 = 1u64

impl<A: Xc3Write, B: Xc3Write> Xc3Write for (A, B)

type Offsets<'a> = (<A as Xc3Write>::Offsets<'a>, <B as Xc3Write>::Offsets<'a>) where A: 'a, B: 'a

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

impl<T> Xc3Write for Option<T>

where T: Xc3Write,

type Offsets<'a> = Option<<T as Xc3Write>::Offsets<'a>> where Self: 'a

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

fn should_write(&self) -> Option<bool>

const ALIGNMENT: u64 = T::ALIGNMENT

impl<T> Xc3Write for Vec<T>

where T: Xc3Write + 'static,

type Offsets<'a> = VecOffsets<<T as Xc3Write>::Offsets<'a>>

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

fn should_write(&self) -> Option<bool>

impl<const N: usize, T> Xc3Write for [T; N]

where T: Xc3Write + 'static,

type Offsets<'a> = ()

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Xc3Result<Self::Offsets<'_>>

Implementors