Struct w5500_ll::SocketInterruptMask

pub struct SocketInterruptMask(/* private fields */);

Socket Interrupt Mask Register (Sn_IMR).

This is used by the Registers::sn_imr and Registers::set_sn_imr methods.

See the SocketInterrupt structure for more information about the individual interrupts.

Implementations

impl SocketInterruptMask

pub const RESET: u8 = 255u8

Socket interrupt mask register (Sn_IMR) reset value.

pub const DEFAULT: Self = _

Default value.

This is the same as default, but as a const value.

Example

use w5500_ll::SocketInterruptMask;

assert_eq!(SocketInterruptMask::DEFAULT, SocketInterruptMask::default());

pub const ALL_MASKED: SocketInterruptMask = _

Mask all socket interrupts.

Example

use w5500_ll::SocketInterruptMask;

assert!(SocketInterruptMask::ALL_MASKED.con_masked());
assert!(SocketInterruptMask::ALL_MASKED.discon_masked());
assert!(SocketInterruptMask::ALL_MASKED.recv_masked());
assert!(SocketInterruptMask::ALL_MASKED.timeout_masked());
assert!(SocketInterruptMask::ALL_MASKED.sendok_masked());

pub const fn con_masked(&self) -> bool

Check if the CON interrupt is masked.

Example

use w5500_ll::SocketInterruptMask;

let simr: SocketInterruptMask = SocketInterruptMask::DEFAULT;
assert!(!simr.con_masked());
let simr: SocketInterruptMask = simr.mask_con();
assert!(simr.con_masked());
let simr: SocketInterruptMask = simr.unmask_con();
assert!(!simr.con_masked());

pub const fn unmask_con(self) -> Self

Unmask the CON interrupt.

pub const fn mask_con(self) -> Self

Mask the CON interrupt.

pub const fn discon_masked(&self) -> bool

Check if the DISCON interrupt is masked.

Example

use w5500_ll::SocketInterruptMask;

let simr: SocketInterruptMask = SocketInterruptMask::DEFAULT;
assert!(!simr.discon_masked());
let simr: SocketInterruptMask = simr.mask_discon();
assert!(simr.discon_masked());
let simr: SocketInterruptMask = simr.unmask_discon();
assert!(!simr.discon_masked());

pub const fn unmask_discon(self) -> Self

Unmask the DISCON interrupt.

pub const fn mask_discon(self) -> Self

Mask the DISCON interrupt.

pub const fn recv_masked(&self) -> bool

Check if the RECV interrupt is masked.

Example

use w5500_ll::SocketInterruptMask;

let simr: SocketInterruptMask = SocketInterruptMask::DEFAULT;
assert!(!simr.recv_masked());
let simr: SocketInterruptMask = simr.mask_recv();
assert!(simr.recv_masked());
let simr: SocketInterruptMask = simr.unmask_recv();
assert!(!simr.recv_masked());

pub const fn unmask_recv(self) -> Self

Unmask the RECV interrupt.

pub const fn mask_recv(self) -> Self

Mask the RECV interrupt.

pub const fn timeout_masked(&self) -> bool

Check if the TIMEOUT interrupt is masked.

Example

use w5500_ll::SocketInterruptMask;

let simr: SocketInterruptMask = SocketInterruptMask::DEFAULT;
assert!(!simr.timeout_masked());
let simr: SocketInterruptMask = simr.mask_timeout();
assert!(simr.timeout_masked());
let simr: SocketInterruptMask = simr.unmask_timeout();
assert!(!simr.timeout_masked());

pub const fn unmask_timeout(self) -> Self

Unmask the TIMEOUT interrupt.

pub const fn mask_timeout(self) -> Self

Mask the TIMEOUT interrupt.

pub const fn sendok_masked(&self) -> bool

Check if the SENDOK interrupt is masked.

Example

use w5500_ll::SocketInterruptMask;

let simr: SocketInterruptMask = SocketInterruptMask::DEFAULT;
assert!(!simr.sendok_masked());
let simr: SocketInterruptMask = simr.mask_sendok();
assert!(simr.sendok_masked());
let simr: SocketInterruptMask = simr.unmask_sendok();
assert!(!simr.sendok_masked());

pub const fn unmask_sendok(self) -> Self

Unmask the SENDOK interrupt.

pub const fn mask_sendok(self) -> Self

Mask the SENDOK interrupt.

Trait Implementations

impl Clone for SocketInterruptMask

fn clone(&self) -> SocketInterruptMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketInterruptMask

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

Formats the value using the given formatter.

impl Default for SocketInterruptMask

fn default() -> Self

Returns the “default value” for a type.

impl Display for SocketInterruptMask

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

Formats the value using the given formatter.

impl Format for SocketInterruptMask

Available on crate feature defmt only.

fn format(&self, fmt: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<SocketInterruptMask> for u8

fn from(val: SocketInterruptMask) -> u8

Converts to this type from the input type.

impl From<u8> for SocketInterruptMask

fn from(val: u8) -> Self

Converts to this type from the input type.

impl PartialEq for SocketInterruptMask

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SocketInterruptMask

impl Eq for SocketInterruptMask

impl StructuralEq for SocketInterruptMask

impl StructuralPartialEq for SocketInterruptMask