Skip to main content

IOEvent

Struct IOEvent 

Source
pub struct IOEvent<C: IOCallback> {
    pub action: IOAction,
    pub offset: i64,
    pub fd: RawFd,
    /* private fields */
}

Fields§

§action: IOAction§offset: i64§fd: RawFd

Implementations§

Source§

impl<C: IOCallback> IOEvent<C>

Source

pub fn new(fd: RawFd, buf: Buffer, action: IOAction, offset: i64) -> Self

Source

pub fn new_no_buf(fd: RawFd, action: IOAction, offset: i64, len: u64) -> Self

Source

pub fn set_fd(&mut self, fd: RawFd)

Source

pub fn set_callback(&mut self, cb: C)

Set callback for IOEvent, might be closure or a custom struct

Source

pub fn get_size(&self) -> u64

Source

pub fn get_write_result(self) -> Result<(), Errno>

Source

pub fn get_result(&self) -> Result<usize, Errno>

Get the result of the IO operation (bytes read/written or error). Returns the number of bytes successfully transferred.

Source

pub fn get_read_result(self) -> Result<Buffer, Errno>

Get the buffer from a read operation. Note: The buffer length is NOT modified. Use get_result() to get actual bytes read.

Source

pub fn callback<F>( self: Box<Self>, check_short_read: F, ) -> Result<(), Box<Self>>
where F: FnOnce(u64) -> bool,

For writing custom callback workers

Callback worker should always call this function on receiving IOEvent from Driver

parameter: check_short_read(offset: u64) should be checking the offset exceed file end. If check_short_read() return true, the callback function will return Err(IOEvent) for I/O resubmit.

NOTE: you should always use a weak reference in check_short_read closure and re-submission.

Source

pub fn callback_unchecked(self, to_fix_short_io: bool)

Perform callback on the IOEvent when cannot re-submit for short i/o

§Arguments
  • to_fix_short_io: should always be true, fix the buffer len of short I/O
§Safety

Only for callback worker does not re-submit when short I/O. Buffer::len() will changed to actual I/O copied size during callback.

Trait Implementations§

Source§

impl<C: IOCallback> Debug for IOEvent<C>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for IOEvent<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for IOEvent<C>
where C: RefUnwindSafe,

§

impl<C> Send for IOEvent<C>

§

impl<C> Sync for IOEvent<C>
where C: Sync,

§

impl<C> Unpin for IOEvent<C>

§

impl<C> UnsafeUnpin for IOEvent<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for IOEvent<C>
where C: 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, 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.