Trait scroll::Pwrite

pub trait Pwrite<Ctx, E, I = usize>: Index<I> + IndexMut<RangeFrom<I>> + MeasureWith<Ctx, Units = I> where
    Ctx: Copy,
    I: Add + Copy + PartialOrd,
    E: From<Error<I>>, {
    fn pwrite<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
        &mut self, 
        n: N, 
        offset: I
    ) -> Result<I, E>
    where
        Ctx: Default,
    { ... }
    fn pwrite_with<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
        &mut self, 
        n: N, 
        offset: I, 
        ctx: Ctx
    ) -> Result<I, E> { ... }
    fn gwrite<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
        &mut self, 
        n: N, 
        offset: &mut I
    ) -> Result<I, E>
    where
        I: AddAssign,
        Ctx: Default,
    { ... }
    fn gwrite_with<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
        &mut self, 
        n: N, 
        offset: &mut I, 
        ctx: Ctx
    ) -> Result<I, E>
    where
        I: AddAssign,
    { ... }
}

Writes into Self at an offset of type I using a Ctx

To implement writing into an arbitrary byte buffer, implement TryIntoCtx

Example

use scroll::{self, ctx, LE, Endian, Pwrite};
#[derive(Debug, PartialEq, Eq)]
pub struct Foo(u16);

// this will use the default `DefaultCtx = scroll::Endian` and `I = usize`...
impl ctx::TryIntoCtx<Endian> for Foo {
    // you can use your own error here too, but you will then need to specify it in fn generic parameters
    type Error = scroll::Error;
    type Size = usize;
    // you can write using your own context too... see `leb128.rs`
    fn try_into_ctx(self, this: &mut [u8], le: Endian) -> Result<Self::Size, Self::Error> {
        if this.len() < 2 { return Err((scroll::Error::Custom("whatever".to_string())).into()) }
        this.pwrite_with(self.0, 0, le)?;
        Ok(2)
    }
}
// now we can write a `Foo` into some buffer (in this case, a byte buffer, because that's what we implemented it for above)

let mut bytes: [u8; 4] = [0, 0, 0, 0];
bytes.pwrite_with(Foo(0x7f), 1, LE).unwrap();

Provided methods

fn pwrite<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
    &mut self,
    n: N,
    offset: I
) -> Result<I, E> where
    Ctx: Default, 

fn pwrite_with<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
    &mut self,
    n: N,
    offset: I,
    ctx: Ctx
) -> Result<I, E>

Write N at offset I with context Ctx

Example

use scroll::{Pwrite, Pread, LE};
let mut bytes: [u8; 8] = [0, 0, 0, 0, 0, 0, 0, 0];
bytes.pwrite_with::<u32>(0xbeefbeef, 0, LE).unwrap();
assert_eq!(bytes.pread_with::<u32>(0, LE).unwrap(), 0xbeefbeef);

fn gwrite<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
    &mut self,
    n: N,
    offset: &mut I
) -> Result<I, E> where
    I: AddAssign,
    Ctx: Default, 

Write n into self at offset, with a default Ctx. Updates the offset.

fn gwrite_with<N: TryIntoCtx<Ctx, Self::Output, Error = E, Size = I>>(
    &mut self,
    n: N,
    offset: &mut I,
    ctx: Ctx
) -> Result<I, E> where
    I: AddAssign, 

Write n into self at offset, with the ctx. Updates the offset.

Loading content...

Implementors

impl<Ctx: Copy, I: Add + Copy + PartialOrd, E: From<Error<I>>, R: ?Sized + Index<I> + IndexMut<RangeFrom<I>> + MeasureWith<Ctx, Units = I>> Pwrite<Ctx, E, I> for R

Loading content...