Skip to main content

WriteRequest

Struct WriteRequest 

Source
pub struct WriteRequest {
    pub allocation: BufPoolAllocation,
    pub slot_index: usize,
}
Expand description

A write operation submitted to WritePipe

The request contains the buffers to persist along with the destination slot index in the underlying [FrozenFile].

§Example

use frozen_core::{bufpool, utils, wpipe};
use std::ptr;

const BUFFER_SIZE: utils::BufferSize = utils::BufferSize::S128;

let pool_cfg = bufpool::BufPoolCfg {
    buffer_size: utils::BufferSize::S128,
    max_memory: 0x400 * BUFFER_SIZE as usize,
};
let pool = bufpool::BufPool::new(pool_cfg);

let payload = vec![0x0A; BUFFER_SIZE as usize];
let allocation = pool.allocate(1);

unsafe {ptr::copy_nonoverlapping(
    payload.as_ptr(),
    allocation.first(),
    payload.len()
)};

let request = wpipe::WriteRequest {allocation, slot_index: 0};
assert!(request.slot_index >= 0);

Fields§

§allocation: BufPoolAllocation

Buffer allocation containing the pages to be written allocated using bufpool::BufPool

§Example

use frozen_core::{bufpool, utils, wpipe};
use std::ptr;

const BUFFER_SIZE: utils::BufferSize = utils::BufferSize::S128;

let pool_cfg = bufpool::BufPoolCfg {
    buffer_size: utils::BufferSize::S128,
    max_memory: 0x400 * BUFFER_SIZE as usize,
};
let pool = bufpool::BufPool::new(pool_cfg);

let payload = vec![0x0A; BUFFER_SIZE as usize];
let allocation = pool.allocate(1);

unsafe {ptr::copy_nonoverlapping(
    payload.as_ptr(),
    allocation.first(),
    payload.len()
)};

let request = wpipe::WriteRequest {allocation, slot_index: 0};
assert!(!request.allocation.first().is_null());
§slot_index: usize

Destination slot index where the pages of the allocation will be written from

§Example

use frozen_core::{bufpool, utils, wpipe};
use std::ptr;

const BUFFER_SIZE: utils::BufferSize = utils::BufferSize::S128;

let pool_cfg = bufpool::BufPoolCfg {
    buffer_size: utils::BufferSize::S128,
    max_memory: 0x400 * BUFFER_SIZE as usize,
};
let pool = bufpool::BufPool::new(pool_cfg);

let payload = vec![0x0A; BUFFER_SIZE as usize];
let allocation = pool.allocate(1);

unsafe {ptr::copy_nonoverlapping(
    payload.as_ptr(),
    allocation.first(),
    payload.len()
)};

let request = wpipe::WriteRequest {allocation, slot_index: 0};
assert!(request.slot_index >= 0);

Trait Implementations§

Source§

impl Debug for WriteRequest

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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, 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.