Struct Config 

pub struct Config { /* private fields */ }

Available on crate feature full only.

A Mapping builder, providing control over the way the underlying buffer is mapped.

Implementations

impl Config

pub fn map<R: Mappable + Default>( self, ) -> Result<Mapping<R, Kernel>, AllocError>

Creates a Mapping in the kernel address space.

The type parameter R is used to determine how the physical and virtual allocations are aligned, as well as some configuration values if left as default values. This can be used to require extra virtual memory to be allocated and left unmapped to act as a guard page. See the module level documentation for more information.

Errors

Propagates an AllocError if the virtual or physical memory allocators have an allocation failure.

pub fn map_in<'a, R: Mappable + Default + Send + 'static>( self, name: Cow<'static, str>, address_space: &'a AddressSpace, ) -> Result<MappingMeta<impl DerefMut<Target = Mapping<Box<dyn Mappable + Send>, Userspace>> + 'a>, AllocError>

Creates a Mapping in a user address space.

On success, returns a MappingMeta which allows access to the created mapping.

The type parameter R is used to determine how the physical and virtual allocations are aligned, as well as some configuration values if left as default values. This can be used to require extra virtual memory to be allocated and left unmapped to act as a guard page. See the module level documentation for more information.

Errors

Propagates an AllocError if the virtual or physical memory allocators have an allocation failure.

pub const fn new(page_count: NonZero<usize>, ty: Ty) -> Self

Constructs a new Config for creating a Mapping with size page_count number of pages.

The following defaults are used:

• Any physical memory location, including discontiguous memory
• Any virtual memory location
• highmem used to allocate physical memory
• Read-only
• Inaccessible from userspace
• Normal cache strategy

Any unspecified defaults are not guaranteed, and should be explicitly specified with the relevant methods if specific behaviour is required.

pub const fn caching(self, caching: Caching) -> Self

Sets the caching method used for the mapping.

See Caching for more information.

pub const fn protection( self, writable: bool, executable: bool, user_accessible: bool, ) -> Self

Sets the protection bits used when creating the mapping.

pub fn with_allocator<const RAM_ONLY: bool>( self, allocator: impl Into<DynPmm<'static, RAM_ONLY>>, ) -> Self

Uses allocator to supply the physical memory for the mapping.

pub const fn physical_location(self, at: RawFrame) -> Self

Requires the mapping to be at a specific physical address.

pub const fn virtual_location(self, at: RawPage) -> Self

Requires the mapping to be at a specific virtual address.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.