Struct il2_iltags::io::array::BorrowedVecWriter

pub struct BorrowedVecWriter<'a> { /* fields omitted */ }

BorrowedVecWriter implements a Writer that uses a borrowed Vec as its backend.

The borrowed vector is used as is. This means that:

• Any existing data will be overwritten from the initial offset;
• The vector will be extended if required but will never shrink to accomodate the amount of data written;

Implementations

impl<'a> BorrowedVecWriter<'a>

pub fn new(vector: &'a mut Vec<u8>) -> Self

Creates a new instance of this struct. The new struct is set as writeable by default.

Arguments:

• vector: The inner vector;

pub fn with_offset(vector: &'a mut Vec<u8>, offset: usize) -> Self

Creates a new instance of this struct. The new struct is set as writeable by default.

Arguments:

• vector: The inner vector;
• offset: The initial offset. If it is set to a value larger than vector length, it will assume the vector length;

pub fn get_offset(&self) -> usize

Returns the current writing position.

Returns:

• The current offset. It is guaranteed to be at most the total size of the data.

pub fn set_offset(&mut self, offset: usize)

Sets the current writing position.

Arguments:

• offset: The new position. It if is larger than the total length, it will assume the total length;

pub fn is_read_only(&self) -> bool

Returns true if this instance is locked for writing.

pub fn set_read_only(&mut self, read_only: bool)

Sets the read-only flag.

Arguments:

• read_only: The new value;

pub fn can_write(&self) -> Result<()>

Verifies if the it is possible to write into this VecWriter.

Returns:

• Ok(()): If it is possible to write;
• Err(ErrorKind::UnableToWriteData): If it is not possible to write;

pub fn as_slice(&self) -> &[u8]

Returns the current data as a slice.

pub fn vec(&self) -> &Vec<u8>

Returns aread-only reference to the inner vector.

pub fn bytes_written(&self) -> usize

Returns the number of bytes actually written.

Trait Implementations

impl<'a> Writer for BorrowedVecWriter<'a>

fn write(&mut self, value: u8) -> Result<()>

Writes a single byte.

fn write_all(&mut self, buff: &[u8]) -> Result<()>

Writes a byte slice. As this default implementation calls write() multiple times, so it is strongly recommended that each implementation provides a more efficient version for this method if possible.

fn as_writer(&mut self) -> &mut dyn Writer