Struct UblkCtrlBuilder 

pub struct UblkCtrlBuilder<'a> { /* private fields */ }

UblkSession: build one new ublk control device or recover the old one.

High level API.

One limit is that IO handling closure doesn’t support FnMut, and low level API doesn’t have such limit.

Implementations

impl<'a> UblkCtrlBuilder<'a>

pub fn name(self, value: &'a str) -> Self

target type, such as null, loop, ramdisk, or nbd,…

pub fn id(self, value: i32) -> Self

device id: -1 can only be used for adding one new device, and ublk driver will allocate one new ID for the created device; otherwise, we are asking driver to create or recover or list one device with specified ID

pub fn nr_queues(self, value: u16) -> Self

how many queues

pub fn depth(self, value: u16) -> Self

each queue’s IO depth

pub fn io_buf_bytes(self, value: u32) -> Self

max size of each IO buffer size, which will be converted to block layer’s queue limit of max hw sectors

pub fn ctrl_flags(self, value: u64) -> Self

passed to ublk driver via sys::ublksrv_ctrl_dev_info.flags, usually for adding or recovering device

pub fn ctrl_target_flags(self, value: u64) -> Self

store target flags in sys::ublksrv_ctrl_dev_info.ublksrv_flags, which is immutable in the whole device lifetime

pub fn dev_flags(self, value: UblkFlags) -> Self

libublk feature flags: UBLK_DEV_F_*

impl UblkCtrlBuilder<'_>

pub fn build(self) -> Result<UblkCtrl, UblkError>

create one pair of ublk devices, the 1st one is control device(UblkCtrl), and the 2nd one is data device(UblkDev)

pub async fn build_async(self) -> Result<UblkCtrlAsync, UblkError>

Trait Implementations

impl<'a> Debug for UblkCtrlBuilder<'a>

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

Formats the value using the given formatter.

impl Default for UblkCtrlBuilder<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for UblkCtrlBuilder<'a>

fn eq(&self, other: &UblkCtrlBuilder<'a>) -> bool

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

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<'a> Eq for UblkCtrlBuilder<'a>

impl<'a> StructuralPartialEq for UblkCtrlBuilder<'a>