Struct ProtoMask 

pub struct ProtoMask { /* private fields */ }

Implementations

impl ProtoMask

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl ProtoMask

pub const fn into_bytes(self) -> [u8; 2]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 2]) -> Self

Converts the given bytes directly into the bitfield struct.

impl ProtoMask

pub fn ubx(&self) -> <bool as Specifier>::InOut

Returns the value of ubx.

pub fn ubx_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of ubx.

#Errors

If the returned value contains an invalid bit pattern for ubx.

pub fn with_ubx(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of ubx set to the given value.

#Panics

If the given value is out of bounds for ubx.

pub fn with_ubx_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of ubx set to the given value.

#Errors

If the given value is out of bounds for ubx.

pub fn set_ubx(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of ubx to the given value.

#Panics

If the given value is out of bounds for ubx.

pub fn set_ubx_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of ubx to the given value.

#Errors

If the given value is out of bounds for ubx.

pub fn nmea(&self) -> <bool as Specifier>::InOut

Returns the value of nmea.

pub fn nmea_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of nmea.

#Errors

If the returned value contains an invalid bit pattern for nmea.

pub fn with_nmea(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of nmea set to the given value.

#Panics

If the given value is out of bounds for nmea.

pub fn with_nmea_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of nmea set to the given value.

#Errors

If the given value is out of bounds for nmea.

pub fn set_nmea(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of nmea to the given value.

#Panics

If the given value is out of bounds for nmea.

pub fn set_nmea_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of nmea to the given value.

#Errors

If the given value is out of bounds for nmea.

pub fn rtcm(&self) -> <bool as Specifier>::InOut

Returns the value of rtcm.

pub fn rtcm_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of rtcm.

#Errors

If the returned value contains an invalid bit pattern for rtcm.

pub fn with_rtcm(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of rtcm set to the given value.

#Panics

If the given value is out of bounds for rtcm.

pub fn with_rtcm_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of rtcm set to the given value.

#Errors

If the given value is out of bounds for rtcm.

pub fn set_rtcm(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of rtcm to the given value.

#Panics

If the given value is out of bounds for rtcm.

pub fn set_rtcm_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of rtcm to the given value.

#Errors

If the given value is out of bounds for rtcm.

pub fn rtcm3(&self) -> <bool as Specifier>::InOut

Returns the value of rtcm3.

pub fn rtcm3_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of rtcm3.

#Errors

If the returned value contains an invalid bit pattern for rtcm3.

pub fn with_rtcm3(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of rtcm3 set to the given value.

#Panics

If the given value is out of bounds for rtcm3.

pub fn with_rtcm3_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of rtcm3 set to the given value.

#Errors

If the given value is out of bounds for rtcm3.

pub fn set_rtcm3(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of rtcm3 to the given value.

#Panics

If the given value is out of bounds for rtcm3.

pub fn set_rtcm3_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of rtcm3 to the given value.

#Errors

If the given value is out of bounds for rtcm3.

Trait Implementations

impl CheckTotalSizeMultipleOf8 for ProtoMask

type Size = TotalSize<[(); 0]>

impl From<ProtoMask> for u16

where [(); 16]: IsU16Compatible,

fn from(__bf_bitfield: ProtoMask) -> Self

Converts to this type from the input type.

impl From<u16> for ProtoMask

where [(); 16]: IsU16Compatible,

fn from(__bf_prim: u16) -> Self

Converts to this type from the input type.