Struct ostd::mm::frame::frame_vec::FrameVec

pub struct FrameVec(/* private fields */);

A collection of base page frames (regular physical memory pages).

For the most parts, FrameVec is like Vec<Frame>. But the implementation may or may not be based on [Vec]. Having a dedicated type to represent a series of page frames is convenient because, more often than not, one needs to operate on a batch of frames rather a single frame.

Implementations

impl FrameVec

pub fn get(&self, index: usize) -> Option<&Frame>

Retrieves a reference to a Frame at the specified index.

pub fn empty() -> Self

Creates an empty FrameVec.

pub fn new_with_capacity(capacity: usize) -> Self

Creates a new FrameVec with the specified capacity.

pub fn push(&mut self, new_frame: Frame)

Pushes a new frame to the collection.

pub fn pop(&mut self) -> Option<Frame>

Pops a frame from the collection.

pub fn remove(&mut self, at: usize) -> Frame

Removes a frame at a position.

pub fn append(&mut self, more: &mut FrameVec) -> Result<()>

Appends all the Frames from more to the end of this collection. and clears the frames in more.

pub fn truncate(&mut self, new_len: usize)

Truncates the FrameVec to the specified length.

If new_len >= self.len(), then this method has no effect.

pub fn iter(&self) -> Iter<'_, Frame>

Returns an iterator over all frames.

pub fn len(&self) -> usize

Returns the number of frames.

pub fn is_empty(&self) -> bool

Returns whether the frame collection is empty.

pub fn nbytes(&self) -> usize

Returns the number of bytes.

This method is equivalent to self.len() * BASE_PAGE_SIZE.

pub fn from_one_frame(frame: Frame) -> Self

Creates a new FrameVec from a single Frame.

Trait Implementations

impl Clone for FrameVec

fn clone(&self) -> FrameVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameVec

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

Formats the value using the given formatter.

impl IntoIterator for FrameVec

type Item = Frame

The type of the elements being iterated over.

type IntoIter = IntoIter<<FrameVec as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl VmIo for FrameVec

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

Reads a specified number of bytes at a specified offset into a given buffer.

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

Writes a specified number of bytes from a given buffer at a specified offset.

fn read_val<T: Pod>(&self, offset: usize) -> Result<T>

Reads a value of a specified type at a specified offset.

fn read_slice<T: Pod>(&self, offset: usize, slice: &mut [T]) -> Result<()>

Reads a slice of a specified type at a specified offset.

fn write_val<T: Pod>(&self, offset: usize, new_val: &T) -> Result<()>

Writes a value of a specified type at a specified offset.

fn write_slice<T: Pod>(&self, offset: usize, slice: &[T]) -> Result<()>

Writes a slice of a specified type at a specified offset.

fn write_vals<'a, T: Pod + 'a, I: Iterator<Item = &'a T>>( &self, offset: usize, iter: I, align: usize, ) -> Result<usize>

Writes a sequence of values given by an iterator (iter) from the specified offset (offset).