Struct IOCON

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

I/O Expander Configuration Register (IOCON) bit definitions.

Implementations

impl IOCON

pub const BANK: Self

Controls how the registers are addressed:

1 = The registers associated with each port are separated into different banks. (Not currently supported in this library.)

0 = The registers are in the same bank (addresses are sequential).

pub const MIRROR: Self

INT Pins Mirror bit:

1 = The INT pins are internally connected.

0 = The INT pins are not connected. INTA is associated with PORTA and INTB is associated with PORTB.

pub const SEQOP: Self

Sequential Operation mode bit:

1 = Sequential operation disabled, address pointer does not increment.

0 = Sequential operation enabled, address pointer increments.

pub const DISSLW: Self

Slew Rate control bit for SDA output:

1 = Slew rate control disabled.

0 = Slew rate control enabled.

pub const HAEN: Self

Hardware Address Enable bit:

1 = Enables the MCP23S17 address pins.

0 = Disables the MCP23S17 address pins.

pub const ODR: Self

Configures the INT pin as an open-drain output:

1 = Open-drain output (overrides the INTPOL bit.)

0 = Active driver output (INTPOL bit sets the polarity.)

pub const INTPOL: Self

Sets the polarity of the INT output pin:

1 = Active-high.

0 = Active-low.

pub const _NA: Self

Unimplemented: Read as 0.

impl IOCON

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl IOCON

pub const fn iter(&self) -> Iter<IOCON>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<IOCON>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl IOCON

pub const BANK_ON: IOCON = IOCON::BANK

The registers associated with each port are separated into different banks. (Not currently supported in this library.)

pub const BANK_OFF: IOCON

The registers are in the same bank (addresses are interleaved sequentially).

pub const MIRROR_ON: IOCON = IOCON::MIRROR

The INT pins are internally connected.

pub const MIRROR_OFF: IOCON

The INT pins are not connected. INTA is associated with PORTA and INTB is associated with PORTB.

pub const SEQOP_ON: IOCON

Sequential operation enabled, address pointer increments.

pub const SEQOP_OFF: IOCON = IOCON::SEQOP

Sequential operation disabled, address pointer does not increment.

pub const DISSLW_SLEW_RATE_CONTROLLED: IOCON

Slew rate control enabled.

pub const DISSLW_SLEW_RATE_MAX: IOCON = IOCON::DISSLW

Slew rate control disabled.

pub const HAEN_ON: IOCON = IOCON::HAEN

Enables the MCP23S17 address pins.

pub const HAEN_OFF: IOCON

Disables the MCP23S17 address pins.

pub const ODR_ON: IOCON = IOCON::ODR

Open-drain output (overrides the INTPOL bit.)

pub const ODR_OFF: IOCON

Active driver output (INTPOL bit sets the polarity.)

pub const INTPOL_HIGH: IOCON = IOCON::INTPOL

Active-high.

pub const INTPOL_LOW: IOCON

Active-low.

Trait Implementations

impl Binary for IOCON

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

Formats the value using the given formatter.

impl BitAnd for IOCON

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

The bitwise and (&) of the bits in two flags values.

type Output = IOCON

The resulting type after applying the & operator.

impl BitAndAssign for IOCON

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for IOCON

fn bitor(self, other: IOCON) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = IOCON

The resulting type after applying the | operator.

impl BitOrAssign for IOCON

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for IOCON

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = IOCON

The resulting type after applying the ^ operator.

impl BitXorAssign for IOCON

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Extend<IOCON> for IOCON

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for IOCON

const FLAGS: &'static [Flag<IOCON>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> IOCON

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<IOCON> for IOCON

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for IOCON

type Item = IOCON

The type of the elements being iterated over.

type IntoIter = Iter<IOCON>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for IOCON

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

Formats the value using the given formatter.

impl Not for IOCON

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = IOCON

The resulting type after applying the ! operator.

impl Octal for IOCON

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

Formats the value using the given formatter.

impl PublicFlags for IOCON

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for IOCON

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = IOCON

The resulting type after applying the - operator.

impl SubAssign for IOCON

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for IOCON

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

Formats the value using the given formatter.