Struct solana_rbpf::aligned_memory::AlignedMemory

pub struct AlignedMemory<const ALIGN: usize> { /* private fields */ }

Provides u8 slices at a specified alignment

Implementations

impl<const ALIGN: usize> AlignedMemory<ALIGN>

pub fn from_slice(data: &[u8]) -> Self

Returns a filled AlignedMemory by copying the given slice

pub fn with_capacity(max_len: usize) -> Self

Returns a new empty AlignedMemory with uninitialized preallocated memory

pub fn with_capacity_zeroed(max_len: usize) -> Self

Returns a new empty AlignedMemory with zero initialized preallocated memory

pub fn zero_filled(max_len: usize) -> Self

Returns a new filled AlignedMemory with zero initialized preallocated memory

pub fn mem_size(&self) -> usize

Calculate memory size

pub fn len(&self) -> usize

Get the length of the data

pub fn is_empty(&self) -> bool

Is the memory empty

pub fn write_index(&self) -> usize

Get the current write index

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

Get an aligned slice

pub fn as_slice_mut(&mut self) -> &mut [u8]

Get an aligned mutable slice

pub fn fill_write(&mut self, num: usize, value: u8) -> Result<()>

Grows memory with value repeated num times starting at the write_index

pub unsafe fn write_unchecked<T: Pod>(&mut self, value: T)

Write a generic type T into the memory.

Safety

Unsafe since it assumes that there is enough capacity.

pub unsafe fn write_all_unchecked(&mut self, value: &[u8])

Write a slice of bytes into the memory.

Safety

Unsafe since it assumes that there is enough capacity.

Trait Implementations

impl<const ALIGN: usize> Clone for AlignedMemory<ALIGN>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const ALIGN: usize> Debug for AlignedMemory<ALIGN>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const ALIGN: usize, T: AsRef<[u8]>> From<T> for AlignedMemory<ALIGN>

fn from(bytes: T) -> Self

Converts to this type from the input type.

impl<const ALIGN: usize> PartialEq for AlignedMemory<ALIGN>

fn eq(&self, other: &AlignedMemory<ALIGN>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const ALIGN: usize> Write for AlignedMemory<ALIGN>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<const ALIGN: usize> Eq for AlignedMemory<ALIGN>

impl<const ALIGN: usize> StructuralEq for AlignedMemory<ALIGN>

impl<const ALIGN: usize> StructuralPartialEq for AlignedMemory<ALIGN>