Struct aya::maps::queue::Queue

source · [−]

pub struct Queue<T: Deref<Target = Map>, V: Pod> { /* private fields */ }

Expand description

A FIFO queue.

Minimum kernel version

The minimum kernel version required to use this feature is 4.20.

Examples

use aya::maps::Queue;
use std::convert::TryFrom;

let mut queue = Queue::try_from(bpf.map_mut("ARRAY")?)?;
queue.push(42, 0)?;
queue.push(43, 0)?;
assert_eq!(queue.pop(0)?, 42);

Implementations

source

impl<T: Deref<Target = Map>, V: Pod> Queue<T, V>

source

pub fn capacity(&self) -> u32

Returns the number of elements the queue can hold.

This corresponds to the value of bpf_map_def::max_entries on the eBPF side.

source

impl<T: Deref<Target = Map> + DerefMut<Target = Map>, V: Pod> Queue<T, V>

source

pub fn pop(&mut self, flags: u64) -> Result<V, MapError>

Removes the first element and returns it.

Errors

Returns MapError::ElementNotFound if the queue is empty, MapError::SyscallError if bpf_map_lookup_and_delete_elem fails.

source

pub fn push(&mut self, value: V, flags: u64) -> Result<(), MapError>

Appends an element at the end of the queue.

Errors

MapError::SyscallError if bpf_map_update_elem fails.

Trait Implementations

source

impl<V: Pod> TryFrom<MapRef> for Queue<MapRef, V>

type Error = MapError

The type returned in the event of a conversion error.

source

fn try_from(a: MapRef) -> Result<Queue<MapRef, V>, MapError>

Performs the conversion.

source

impl<V: Pod> TryFrom<MapRefMut> for Queue<MapRefMut, V>

type Error = MapError

The type returned in the event of a conversion error.

source

fn try_from(a: MapRefMut) -> Result<Queue<MapRefMut, V>, MapError>

Performs the conversion.

Auto Trait Implementations

impl<T, V> RefUnwindSafe for Queue<T, V> where
T: RefUnwindSafe,
V: RefUnwindSafe,

impl<T, V> Send for Queue<T, V> where
T: Send,
V: Send,

impl<T, V> Sync for Queue<T, V> where
T: Sync,
V: Sync,

impl<T, V> Unpin for Queue<T, V> where
T: Unpin,
V: Unpin,

impl<T, V> UnwindSafe for Queue<T, V> where
T: UnwindSafe,
V: 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,

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, 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 aya::maps::queue::Queue

Implementations

impl<T: Deref<Target = Map>, V: Pod> Queue<T, V>

pub fn capacity(&self) -> u32

impl<T: Deref<Target = Map> + DerefMut<Target = Map>, V: Pod> Queue<T, V>

pub fn pop(&mut self, flags: u64) -> Result<V, MapError>

pub fn push(&mut self, value: V, flags: u64) -> Result<(), MapError>

Trait Implementations

impl<V: Pod> TryFrom<MapRef> for Queue<MapRef, V>

type Error = MapError

fn try_from(a: MapRef) -> Result<Queue<MapRef, V>, MapError>

impl<V: Pod> TryFrom<MapRefMut> for Queue<MapRefMut, V>

type Error = MapError

fn try_from(a: MapRefMut) -> Result<Queue<MapRefMut, V>, MapError>

Auto Trait Implementations

impl<T, V> RefUnwindSafe for Queue<T, V> where T: RefUnwindSafe, V: RefUnwindSafe,

impl<T, V> Send for Queue<T, V> where T: Send, V: Send,

impl<T, V> Sync for Queue<T, V> where T: Sync, V: Sync,

impl<T, V> Unpin for Queue<T, V> where T: Unpin, V: Unpin,

impl<T, V> UnwindSafe for Queue<T, V> where T: UnwindSafe, V: UnwindSafe,

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, 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, V> RefUnwindSafe for Queue<T, V> where
T: RefUnwindSafe,
V: RefUnwindSafe,

impl<T, V> Send for Queue<T, V> where
T: Send,
V: Send,

impl<T, V> Sync for Queue<T, V> where
T: Sync,
V: Sync,

impl<T, V> Unpin for Queue<T, V> where
T: Unpin,
V: Unpin,

impl<T, V> UnwindSafe for Queue<T, V> where
T: UnwindSafe,
V: UnwindSafe,

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, U> TryFrom<U> for T where
U: Into<T>,

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