Struct Frame Copy item path

impl<M: AnyFrameMeta> Frame<M>

pub fn from_unused(paddr: Paddr, metadata: M) -> Result<Self, GetFrameError>

Gets a Frame with a specific usage from a raw, unused page.

The caller should provide the initial metadata of the page.

If the provided frame is not truly unused at the moment, it will return an error. If wanting to acquire a frame that is already in use, use Frame::from_in_use instead.

pub fn meta(&self) -> &M

Gets the metadata of this page.

impl Frame<dyn AnyFrameMeta>

pub fn from_in_use(paddr: Paddr) -> Result<Self, GetFrameError>

Gets a dynamically typed Frame from a raw, in-use page.

If the provided frame is not in use at the moment, it will return an error.

The returned frame will have an extra reference count to the frame.

impl<M: AnyFrameMeta + ?Sized> Frame<M>

pub const fn map_level(&self) -> PagingLevel

Gets the map level of this page.

This is the level of the page table entry that maps the frame, which determines the size of the frame.

Currently, the level is always 1, which means the frame is a regular page frame.

pub fn dyn_meta(&self) -> &dyn AnyFrameMeta

Gets the dyncamically-typed metadata of this frame.

If the type is known at compile time, use Frame::meta instead.

pub fn reference_count(&self) -> u64

Gets the reference count of the frame.

It returns the number of all references to the frame, including all the existing frame handles (Frame, Frame<dyn AnyFrameMeta>), and all the mappings in the page table that points to the frame.

§Safety

The function is safe to call, but using it requires extra care. The reference count can be changed by other threads at any time including potentially between calling this method and acting on the result.

pub fn borrow(&self) -> FrameRef<'_, M>

Borrows a reference from the given frame.

Trait Implementations§

impl<M: AnyFrameMeta + ?Sized> Clone for Frame<M>

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl<M: AnyFrameMeta + ?Sized> Debug for Frame<M>

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

Formats the value using the given formatter. Read more

impl<M: AnyFrameMeta + ?Sized> Drop for Frame<M>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<M: AnyFrameMeta> From<Frame<M>> for Frame<dyn AnyFrameMeta>

fn from(frame: Frame<M>) -> Self

Converts to this type from the input type.

impl<M: AnyUFrameMeta> From<Frame<M>> for UFrame

fn from(frame: Frame<M>) -> Self

Converts to this type from the input type.

impl<M: AnyFrameMeta + ?Sized> From<Frame<M>> for Segment<M>

fn from(frame: Frame<M>) -> Self

Converts to this type from the input type.

impl From<Frame<dyn AnyUFrameMeta>> for Frame<dyn AnyFrameMeta>

fn from(frame: UFrame) -> Self

Converts to this type from the input type.

impl<M: AnyFrameMeta + ?Sized> From<UniqueFrame<M>> for Frame<M>

fn from(unique: UniqueFrame<M>) -> Self

Converts to this type from the input type.

impl<M: AnyFrameMeta + ?Sized> HasPaddr for Frame<M>

fn paddr(&self) -> Paddr

Returns the start physical address of the memory object.

impl<M: AnyFrameMeta + ?Sized> HasSize for Frame<M>

fn size(&self) -> usize

Returns the size of the memory object in bytes.

impl<UM: AnyUFrameMeta + ?Sized> HasVmReaderWriter for Frame<UM>

type Types = VmReaderWriterIdentity

A marker type that denotes the return types of Self::reader and Self::writer. Read more

fn reader(&self) -> VmReader<'_, Infallible>

Returns a reader to read data from it.

fn writer(&self) -> VmWriter<'_, Infallible>

Returns a writer to write data to it.

impl<M: AnyFrameMeta + ?Sized> NonNullPtr for Frame<M>

const ALIGN_BITS: u32 = 3u32

The power of two of the pointer alignment.

type Target = PhantomData<Frame<M>>

The target type that this pointer refers to.

type Ref<'a> = FrameRef<'a, M> where Self: 'a

A type that behaves just like a shared reference to the NonNullPtr.

fn into_raw(self) -> NonNull<Self::Target>

Converts to a raw pointer. Read more

unsafe fn from_raw(raw: NonNull<Self::Target>) -> Self

Converts back from a raw pointer. Read more

unsafe fn raw_as_ref<'a>(raw: NonNull<Self::Target>) -> Self::Ref<'a>

Obtains a shared reference to the original pointer. Read more

fn ref_as_raw(ptr_ref: Self::Ref<'_>) -> NonNull<Self::Target>

Converts a shared reference to a raw pointer.

impl<M: AnyFrameMeta + ?Sized> PartialEq for Frame<M>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0§

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

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

impl<M: AnyFrameMeta + ?Sized> TryFrom<Frame<M>> for UniqueFrame<M>

fn try_from(frame: Frame<M>) -> Result<Self, Self::Error>

Tries to get a unique frame from a shared frame.

If the reference count is not 1, the frame is returned back.

type Error = Frame<M>

The type returned in the event of a conversion error.

impl<M: AnyFrameMeta> TryFrom<Frame<dyn AnyFrameMeta>> for Frame<M>

fn try_from(dyn_frame: Frame<dyn AnyFrameMeta>) -> Result<Self, Self::Error>

Tries converting a Frame<dyn AnyFrameMeta> into the statically-typed Frame.

If the usage of the frame is not the same as the expected usage, it will return the dynamic frame itself as is.

type Error = Frame<dyn AnyFrameMeta>

The type returned in the event of a conversion error.

impl TryFrom<Frame<dyn AnyFrameMeta>> for UFrame

fn try_from(dyn_frame: Frame<dyn AnyFrameMeta>) -> Result<Self, Self::Error>

Tries converting a Frame<dyn AnyFrameMeta> into UFrame.

If the usage of the frame is not the same as the expected usage, it will return the dynamic frame itself as is.

type Error = Frame<dyn AnyFrameMeta>

The type returned in the event of a conversion error.

impl<M: AnyFrameMeta + ?Sized> Eq for Frame<M>

impl<M: AnyFrameMeta + ?Sized> Send for Frame<M>

impl<M: AnyFrameMeta + ?Sized> Sync for Frame<M>

Auto Trait Implementations§

impl<M> !UnwindSafe for Frame<M>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> HasPaddrRange for T
where T: HasPaddr + HasSize,

fn end_paddr(&self) -> usize

Returns the end physical address of the memory object.

fn paddr_range(&self) -> Range<usize>

Returns the physical address range of the memory object.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<S> VmIo for S
where S: HasVmReaderWriter + Send + Sync,

fn read(&self, offset: usize, writer: &mut VmWriter<'_>) -> Result<(), Error>

Reads requested data at a specified offset into a given VmWriter. Read more

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

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

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

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

fn write(&self, offset: usize, reader: &mut VmReader<'_>) -> Result<(), Error>

Writes all data from a given VmReader at a specified offset. Read more

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

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

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

Writes 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. Read more

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

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

impl<S> VmIoFill for S
where S: HasVmReaderWriter,

fn fill_zeros(&self, offset: usize, len: usize) -> Result<(), (Error, usize)>

Writes len zeros at a specified offset. Read more

impl<S> VmIoOnce for S
where S: HasVmReaderWriter,

fn read_once<T>(&self, offset: usize) -> Result<T, Error>
where T: PodOnce,

Reads a value of the PodOnce type at the specified offset using one non-tearing memory load. Read more