Struct binrw::VecArgs

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

Named arguments for the BinRead::read_options() implementation of Vec.

Examples

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

#[derive(BinRead)]
#[br(little)]
struct Collection {
    count: u16,
    #[br(args {
        count: count.into(),
        inner: ElementBinReadArgs { count: 2 },
    })]
    elements: Vec<Element>,
}

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

assert_eq!(
    Collection::read(&mut Cursor::new(b"\x03\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])
        ]
    }
)

The inner field can be omitted completely if the inner type doesn’t require arguments, in which case a default value will be used:

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

Fields

count: usize

The number of elements to read.

inner: Inner

The arguments for the inner type.

Implementations

impl<Inner: Clone> VecArgs<Inner>

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

Creates a new builder for this type.

Trait Implementations

impl<Inner: Clone + Clone> Clone for VecArgs<Inner>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Inner: Clone> NamedArgs for VecArgs<Inner>

type Builder = VecArgsBuilder<Inner, Needed, Needed>

The builder type for this type.

fn builder() -> Self::Builder

Creates a new builder for this type.