Struct xsk_rs::config::UmemConfigBuilder

source · [−]

pub struct UmemConfigBuilder { /* private fields */ }

Expand description

Builder for a UmemConfig.

Implementations

source

impl ConfigBuilder

source

pub fn new() -> Self

Creates a new UmemConfigBuilder instance.

source

pub fn frame_size(&mut self, size: FrameSize) -> &mut Self

Set the frame size. Default is XSK_UMEM__DEFAULT_FRAME_SIZE.

source

pub fn fill_queue_size(&mut self, size: QueueSize) -> &mut Self

Set the FillQueue size. Default is XSK_RING_PROD__DEFAULT_NUM_DESCS.

source

pub fn comp_queue_size(&mut self, size: QueueSize) -> &mut Self

Set the CompQueue size. Default is XSK_RING_CONS__DEFAULT_NUM_DESCS.

source

pub fn frame_headroom(&mut self, headroom: u32) -> &mut Self

Set the frame headroom available to the user. Default size is XSK_UMEM__DEFAULT_FRAME_HEADROOM.

Not to be confused with XDP_PACKET_HEADROOM which is the amount of headroom reserved by XDP.

source

pub fn build(&self) -> Result<Config, ConfigBuildError>

Build a UmemConfig instance using the values set in this builder.

May fail if some of the values are incompatible. For example, if the requested frame headroom exceeds the frame size.

Trait Implementations

source

impl Clone for ConfigBuilder

source

fn clone(&self) -> ConfigBuilder

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for ConfigBuilder

source

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

Formats the value using the given formatter. Read more

source

impl Default for ConfigBuilder

source

fn default() -> ConfigBuilder

Returns the “default value” for a type. Read more

source

impl Copy for ConfigBuilder

Auto Trait Implementations

impl RefUnwindSafe for ConfigBuilder

impl Send for ConfigBuilder

impl Sync for ConfigBuilder

impl Unpin for ConfigBuilder

impl UnwindSafe for ConfigBuilder

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct xsk_rs::config::UmemConfigBuilder

Implementations

impl ConfigBuilder

pub fn new() -> Self

pub fn frame_size(&mut self, size: FrameSize) -> &mut Self

pub fn fill_queue_size(&mut self, size: QueueSize) -> &mut Self

pub fn comp_queue_size(&mut self, size: QueueSize) -> &mut Self

pub fn frame_headroom(&mut self, headroom: u32) -> &mut Self

pub fn build(&self) -> Result<Config, ConfigBuildError>

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

fn clone_from(&mut self, source: &Self)

impl Debug for ConfigBuilder

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

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

impl Copy for ConfigBuilder

Auto Trait Implementations

impl RefUnwindSafe for ConfigBuilder

impl Send for ConfigBuilder

impl Sync for ConfigBuilder

impl Unpin for ConfigBuilder

impl UnwindSafe for ConfigBuilder

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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