Enum esp_idf_bindgen::pbuf_type

#[repr(u32)]pub enum pbuf_type {
    PBUF_RAM,
    PBUF_ROM,
    PBUF_REF,
    PBUF_POOL,
}

@ingroup pbuf Enumeration of pbuf types

Variants

PBUF_RAM

pbuf data is stored in RAM, used for TX mostly, struct pbuf and its payload are allocated in one piece of contiguous memory (so the first payload byte can be calculated from struct pbuf). pbuf_alloc() allocates PBUF_RAM pbufs as unchained pbufs (although that might change in future versions). This should be used for all OUTGOING packets (TX).

PBUF_ROM

pbuf data is stored in ROM, i.e. struct pbuf and its payload are located in totally different memory areas. Since it points to ROM, payload does not have to be copied when queued for transmission.

PBUF_REF

pbuf comes from the pbuf pool. Much like PBUF_ROM but payload might change so it has to be duplicated when queued before transmitting, depending on who has a 'ref' to it.

PBUF_POOL

pbuf payload refers to RAM. This one comes from a pool and should be used for RX. Payload can be chained (scatter-gather RX) but like PBUF_RAM, struct pbuf and its payload are allocated in one piece of contiguous memory (so the first payload byte can be calculated from struct pbuf). Don't use this for TX, if the pool becomes empty e.g. because of TCP queuing, you are unable to receive TCP acks!

Trait Implementations

impl Clone for pbuf_type

fn clone(&self) -> pbuf_type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for pbuf_type

impl Debug for pbuf_type

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

Formats the value using the given formatter.

impl Eq for pbuf_type

impl Hash for pbuf_type

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<pbuf_type> for pbuf_type

fn eq(&self, other: &pbuf_type) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for pbuf_type

impl StructuralPartialEq for pbuf_type