Struct CoreApi

Source

pub struct CoreApi<'a, BP>(/* private fields */)
where
    BP: ContextProvider,
    BP::Context: BindingsTypes;

Expand description

The single entry point for function calls into netstack3 core.

Implementations§

Source §

impl<'a, BP> CoreApi<'a, BP>
where BP: ContextProvider, BP::Context: BindingsTypes,

Source

pub fn udp<I: Ip>( self, ) -> UdpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the UDP API for IP version I.

Source

pub fn icmp_echo<I: Ip>( self, ) -> IcmpEchoSocketApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the ICMP socket API for IP version I.

Source

pub fn tcp<I: Ip>( self, ) -> TcpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the TCP API for IP version I.

Source

pub fn raw_ip_socket<I: Ip>( self, ) -> RawIpSocketApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the raw IP socket API.

Source

pub fn device_socket( self, ) -> DeviceSocketApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the device socket API.

Source

pub fn filter( self, ) -> FilterApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the filtering API.

Source

pub fn routes<I: Ip>( self, ) -> RoutesApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the routes API for IP version I.

Source

pub fn routes_any( self, ) -> RoutesAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the routes API for all IP versions.

Source

pub fn multicast_forwarding<I: Ip>( self, ) -> MulticastForwardingApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the multicast forwarding API for IP version I.

Source

pub fn neighbor<I: Ip, D>( self, ) -> NeighborApi<I, D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the neighbor API for IP version I and device D.

Source

pub fn device<D>( self, ) -> DeviceApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the device API for device type D.

Source

pub fn device_any( self, ) -> DeviceAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the device API for all device types.

Source

pub fn device_ip<I: Ip>( self, ) -> DeviceIpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the device IP API for IP version `I``.

Source

pub fn device_ip_any( self, ) -> DeviceIpAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the device IP API for all IP versions.

Source

pub fn transmit_queue<D>( self, ) -> TransmitQueueApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the transmit queue API for device type D.

Source

pub fn receive_queue<D>( self, ) -> ReceiveQueueApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the receive queue API for device type D.

Source

pub fn counters( self, ) -> CountersApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

Gets access to the counters API.

Source

pub fn handle_timer( &mut self, dispatch: TimerId<BP::Context>, timer: <BP::Context as TimerBindingsTypes>::UniqueTimerId, )
where BP::Context: BindingsContext,

Handles a timer.

Auto Trait Implementations§

§

impl<'a, BP> Freeze for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Freeze,

§

impl<'a, BP> RefUnwindSafe for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: RefUnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

§

impl<'a, BP> Send for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Send, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

§

impl<'a, BP> Sync for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Sync, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

§

impl<'a, BP> Unpin for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Unpin,

§

impl<'a, BP> UnwindSafe for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: UnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

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

§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.

§

type Init = T

The type for initializers.

§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

impl<CC, BC, Meta> RecvFrameContext<Meta, BC> for CC
where Meta: ReceivableFrameMeta<CC, BC>,

Source §

fn receive_frame(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: B)
where B: BufferMut + Debug,

Receive a frame. Read more

Source §

impl<T> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CC
where Meta: SendableFrameMeta<CC, BC>,

Source §

fn send_frame<S>( &mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S, ) -> Result<(), ErrorAndSerializer<SendFrameErrorReason, S>>
where S: Serializer, <S as Serializer>::Buffer: BufferMut,

Send a frame. Read more

Source §

impl<Id, CC, BC> TimerHandler<BC, Id> for CC
where BC: TimerBindingsTypes, Id: HandleableTimer<CC, BC>,

Source §

fn handle_timer( &mut self, bindings_ctx: &mut BC, dispatch: Id, timer: <BC as TimerBindingsTypes>::UniqueTimerId, )

Handle a timer firing. Read more

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<L, T> UnlockedAccess<L> for T
where L: UnlockedAccessMarkerFor<T>,

Source §

type Data = <L as UnlockedAccessMarkerFor<T>>::Data

The type of state being accessed.

Source §

type Guard<'l> = &'l <L as UnlockedAccessMarkerFor<T>>::Data where T: 'l

A guard providing read access to the data.

Source §

fn access(&self) -> <T as UnlockedAccess<L>>::Guard<'_>

How to access the state.

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source §

Struct CoreApiCopy item path

Implementations§

impl<'a, BP> CoreApi<'a, BP>where BP: ContextProvider, BP::Context: BindingsTypes,

pub fn udp<I: Ip>( self, ) -> UdpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn icmp_echo<I: Ip>( self, ) -> IcmpEchoSocketApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn tcp<I: Ip>( self, ) -> TcpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn raw_ip_socket<I: Ip>( self, ) -> RawIpSocketApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn device_socket( self, ) -> DeviceSocketApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn filter( self, ) -> FilterApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn routes<I: Ip>( self, ) -> RoutesApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn routes_any( self, ) -> RoutesAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn multicast_forwarding<I: Ip>( self, ) -> MulticastForwardingApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn neighbor<I: Ip, D>( self, ) -> NeighborApi<I, D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn device<D>( self, ) -> DeviceApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn device_any( self, ) -> DeviceAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn device_ip<I: Ip>( self, ) -> DeviceIpApi<I, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn device_ip_any( self, ) -> DeviceIpAnyApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn transmit_queue<D>( self, ) -> TransmitQueueApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn receive_queue<D>( self, ) -> ReceiveQueueApi<D, CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn counters( self, ) -> CountersApi<CtxPair<CoreCtx<'a, <BP as ContextProvider>::Context, Unlocked>, BP>>

pub fn handle_timer( &mut self, dispatch: TimerId<BP::Context>, timer: <BP::Context as TimerBindingsTypes>::UniqueTimerId, )where BP::Context: BindingsContext,

Auto Trait Implementations§

impl<'a, BP> Freeze for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: Freeze,

impl<'a, BP> RefUnwindSafe for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: RefUnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

impl<'a, BP> Send for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: Send, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

impl<'a, BP> Sync for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: Sync, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

impl<'a, BP> Unpin for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: Unpin,

impl<'a, BP> UnwindSafe for CoreApi<'a, BP>where <BP as ContextProvider>::Context: Sized, BP: UnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T, D> Encode<Ambiguous1, D> for Twhere D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

impl<T, D> Encode<Ambiguous2, D> for Twhere D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<CC, BC, Meta> RecvFrameContext<Meta, BC> for CCwhere Meta: ReceivableFrameMeta<CC, BC>,

fn receive_frame<B>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: B)where B: BufferMut + Debug,

impl<T> Same for T

type Output = T

impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CCwhere Meta: SendableFrameMeta<CC, BC>,

fn send_frame<S>( &mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S, ) -> Result<(), ErrorAndSerializer<SendFrameErrorReason, S>>where S: Serializer, <S as Serializer>::Buffer: BufferMut,

impl<Id, CC, BC> TimerHandler<BC, Id> for CCwhere BC: TimerBindingsTypes, Id: HandleableTimer<CC, BC>,

fn handle_timer( &mut self, bindings_ctx: &mut BC, dispatch: Id, timer: <BC as TimerBindingsTypes>::UniqueTimerId, )

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

type Error = Infallible

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

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

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

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

impl<L, T> UnlockedAccess<L> for Twhere L: UnlockedAccessMarkerFor<T>,

type Data = <L as UnlockedAccessMarkerFor<T>>::Data

type Guard<'l> = &'l <L as UnlockedAccessMarkerFor<T>>::Data where T: 'l

fn access(&self) -> <T as UnlockedAccess<L>>::Guard<'_>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<B, A> LockBefore<B> for Awhere B: LockAfter<A>,

Struct CoreApi

impl<'a, BP> CoreApi<'a, BP>
where BP: ContextProvider, BP::Context: BindingsTypes,

pub fn handle_timer( &mut self, dispatch: TimerId<BP::Context>, timer: <BP::Context as TimerBindingsTypes>::UniqueTimerId, )
where BP::Context: BindingsContext,

impl<'a, BP> Freeze for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Freeze,

impl<'a, BP> RefUnwindSafe for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: RefUnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

impl<'a, BP> Send for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Send, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

impl<'a, BP> Sync for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Sync, <<BP as ContextProvider>::Context as InstantBindingsTypes>::AtomicInstant: Send + Sync, <<BP as ContextProvider>::Context as FilterBindingsTypes>::DeviceClass: Sync + Send,

impl<'a, BP> Unpin for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: Unpin,

impl<'a, BP> UnwindSafe for CoreApi<'a, BP>
where <BP as ContextProvider>::Context: Sized, BP: UnwindSafe, <<BP as ContextProvider>::Context as InstantBindingsTypes>::Instant: RefUnwindSafe,

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, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<CC, BC, Meta> RecvFrameContext<Meta, BC> for CC
where Meta: ReceivableFrameMeta<CC, BC>,

fn receive_frame<B>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: B)
where B: BufferMut + Debug,

impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CC
where Meta: SendableFrameMeta<CC, BC>,

fn send_frame<S>( &mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S, ) -> Result<(), ErrorAndSerializer<SendFrameErrorReason, S>>
where S: Serializer, <S as Serializer>::Buffer: BufferMut,

impl<Id, CC, BC> TimerHandler<BC, Id> for CC
where BC: TimerBindingsTypes, Id: HandleableTimer<CC, BC>,

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

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

impl<L, T> UnlockedAccess<L> for T
where L: UnlockedAccessMarkerFor<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

impl<B, A> LockBefore<B> for A
where B: LockAfter<A>,