Struct EasyMmapBuilder

Source
pub struct EasyMmapBuilder<T> { /* private fields */ }
Expand description

The builder class for the EasyMmap struct. Provides an easy-to-use interface to create a new EasyMmap struct.

Implementations§

Source§

impl<'a, T> EasyMmapBuilder<T>

Source

pub fn new() -> EasyMmapBuilder<T>

Creates a new EasyMmapBuilder struct.

Source

pub fn build(self) -> EasyMmap<'a, T>
where T: Copy,

Builds the memory map with the given specifications. If the file has been specified, its size will be set to the requirements of the map.

Source

pub fn file(self, file: File) -> EasyMmapBuilder<T>

Passes the ownership of the file to the memory map.

Source

pub fn capacity(self, capacity: usize) -> EasyMmapBuilder<T>

Sets the capacity that the mapped region must have. This capacity must be the number of objects of type T that can be stored in the memory map.

Source

pub fn options(self, options: &[MapOption]) -> EasyMmapBuilder<T>

Batch sets the options that the mapped region must have.

Source

pub fn add_option(self, option: MapOption) -> EasyMmapBuilder<T>

Adds an individual option.

Source

pub fn readable(self) -> EasyMmapBuilder<T>

Source

pub fn writable(self) -> EasyMmapBuilder<T>

Auto Trait Implementations§

§

impl<T> Freeze for EasyMmapBuilder<T>

§

impl<T> RefUnwindSafe for EasyMmapBuilder<T>
where T: RefUnwindSafe,

§

impl<T> !Send for EasyMmapBuilder<T>

§

impl<T> !Sync for EasyMmapBuilder<T>

§

impl<T> Unpin for EasyMmapBuilder<T>
where T: Unpin,

§

impl<T> UnwindSafe for EasyMmapBuilder<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.