Struct binrw::VecArgs

pub struct VecArgs<B> {
    pub count: usize,
    pub inner: B,
}

Arguments passed to the binread impl for Vec

Examples

use binrw::{BinRead, io::Cursor};

#[derive(BinRead, Debug, PartialEq)]
struct Collection {
    count: u32,
    #[br(args { count: count as usize, inner: ElementBinReadArgs { count: 2 } })]
    elements: Vec<Element>,
}

#[derive(BinRead, Debug, PartialEq)]
#[br(import { count: u32 })]
struct Element(#[br(args { count: count as usize, inner: () })] Vec<u8>);

assert_eq!(
    Collection::read(&mut Cursor::new(b"\x03\0\0\0\x04\0\x05\0\x06\0")).unwrap(),
    Collection {
        count: 3,
        elements: vec![
            Element(vec![4, 0]),
            Element(vec![5, 0]),
            Element(vec![6, 0])
        ]
    }
)

Inner types that don’t require args take unit args.

#[derive(BinRead)]
struct Collection {
    count: u32,
    #[br(args { count: count as usize, inner: () })]
    elements: Vec<u32>,
}

Unit args for the inner type can be omitted. The count attribute also assumes unit args for the inner type.

#[derive(BinRead)]
struct Collection {
    count: u32,
    #[br(args { count: count as usize })]
    elements: Vec<u32>,
}

Fields

count: usize

The number of elements to read.

inner: B

Arguments to pass to the inner type

Implementations

impl<B> VecArgs<B>

pub fn builder() -> VecArgsBuilder<B, Needed, Needed>

An inherent method version of BinrwNamedArgs, designed for use with binrw::args!.

Trait Implementations

impl<B> BinrwNamedArgs for VecArgs<B>

type Builder = VecArgsBuilder<B, Needed, Needed>

The initial builder type from which this type can be constructed

fn builder() -> Self::Builder

A method for creating a new builder to construct this type from

impl<B: Clone> Clone for VecArgs<B>

fn clone(&self) -> VecArgs<B>

Returns a copy of the value.

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

Performs copy-assignment from source.