Enum w5500_ll::Socket

#[repr(u8)]
pub enum Socket {
    Socket0,
    Socket1,
    Socket2,
    Socket3,
    Socket4,
    Socket5,
    Socket6,
    Socket7,
}

W5500 sockets.

Variants

Socket0

Socket 0.

This is the only socket that can be used in the Macraw mode.

Socket1

Socket 1.

Socket2

Socket 2.

Socket3

Socket 3.

Socket4

Socket 4.

Socket5

Socket 5.

Socket6

Socket 6.

Socket7

Socket 7.

Implementations

impl Socket

pub const fn block(self) -> u8

Get the socket register block select bits.

Example

use w5500_ll::Socket;

assert_eq!(Socket::Socket0.block(), 0b00001);
assert_eq!(Socket::Socket1.block(), 0b00101);
assert_eq!(Socket::Socket2.block(), 0b01001);
assert_eq!(Socket::Socket3.block(), 0b01101);
assert_eq!(Socket::Socket4.block(), 0b10001);
assert_eq!(Socket::Socket5.block(), 0b10101);
assert_eq!(Socket::Socket6.block(), 0b11001);
assert_eq!(Socket::Socket7.block(), 0b11101);

pub const fn tx_block(self) -> u8

Get the socket TX buffer block select bits.

Example

use w5500_ll::Socket;

assert_eq!(Socket::Socket0.tx_block(), 0b00010);
assert_eq!(Socket::Socket1.tx_block(), 0b00110);
assert_eq!(Socket::Socket2.tx_block(), 0b01010);
assert_eq!(Socket::Socket3.tx_block(), 0b01110);
assert_eq!(Socket::Socket4.tx_block(), 0b10010);
assert_eq!(Socket::Socket5.tx_block(), 0b10110);
assert_eq!(Socket::Socket6.tx_block(), 0b11010);
assert_eq!(Socket::Socket7.tx_block(), 0b11110);

pub const fn rx_block(self) -> u8

Get the socket RX buffer block select bits.

Example

use w5500_ll::Socket;

assert_eq!(Socket::Socket0.rx_block(), 0b00011);
assert_eq!(Socket::Socket1.rx_block(), 0b00111);
assert_eq!(Socket::Socket2.rx_block(), 0b01011);
assert_eq!(Socket::Socket3.rx_block(), 0b01111);
assert_eq!(Socket::Socket4.rx_block(), 0b10011);
assert_eq!(Socket::Socket5.rx_block(), 0b10111);
assert_eq!(Socket::Socket6.rx_block(), 0b11011);
assert_eq!(Socket::Socket7.rx_block(), 0b11111);

pub const fn bitmask(self) -> u8

Socket bitmask.

This is useful for masking socket interrupts with set_simr.

Examples

Demonstration:

use w5500_ll::Socket;

assert_eq!(Socket::Socket0.bitmask(), 0x01);
assert_eq!(Socket::Socket1.bitmask(), 0x02);
assert_eq!(Socket::Socket2.bitmask(), 0x04);
assert_eq!(Socket::Socket3.bitmask(), 0x08);
assert_eq!(Socket::Socket4.bitmask(), 0x10);
assert_eq!(Socket::Socket5.bitmask(), 0x20);
assert_eq!(Socket::Socket6.bitmask(), 0x40);
assert_eq!(Socket::Socket7.bitmask(), 0x80);

As an argument of set_simr:

use w5500_ll::{
    blocking::vdm::W5500,
    Registers,
    Socket::{Socket1, Socket3},
};

let mut w5500 = W5500::new(spi, pin);
// enable socket 1 and socket 3 interrupts
const SOCKET_INTERRUPT_MASK: u8 = Socket1.bitmask() | Socket3.bitmask();
w5500.set_simr(SOCKET_INTERRUPT_MASK)?;

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Socket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Socket

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

Formats the value using the given formatter.

impl Hash for Socket

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 Ord for Socket

fn cmp(&self, other: &Socket) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Socket> for Socket

fn eq(&self, other: &Socket) -> 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 PartialOrd<Socket> for Socket

fn partial_cmp(&self, other: &Socket) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u8> for Socket

type Error = u8

The type returned in the event of a conversion error.

fn try_from(val: u8) -> Result<Socket, u8>

Performs the conversion.

impl Copy for Socket

impl Eq for Socket

impl StructuralEq for Socket

impl StructuralPartialEq for Socket