Skip to main content

RomCode

Struct RomCode 

Source
pub struct RomCode(/* private fields */);
Expand description

The 64-bit identity every 1-Wire device carries: family, serial, and CRC.

The bytes are in bus order: the family code first, six serial bytes, then the CRC-8 over the first seven.

§Examples

use pamoja_hal::onewire::RomCode;

let rom = RomCode::new(0x28, 0x0000_05E2_FDC3).expect("a 48-bit serial");
assert_eq!(rom.family(), 0x28);
assert_eq!(rom.serial(), 0x0000_05E2_FDC3);
assert_eq!(RomCode::from_bytes(rom.bytes())?, rom);

Implementations§

Source§

impl RomCode

Source

pub fn new(family: u8, serial: u64) -> Option<RomCode>

Builds a ROM code from a family code and a 48-bit serial, computing the CRC.

§Arguments
  • family - the device family code, 0x28 for a DS18B20.
  • serial - the 48-bit serial number.
§Returns

The ROM code, or None if serial does not fit in 48 bits.

Source

pub fn from_bytes<E>(bytes: [u8; 8]) -> Result<RomCode, OneWireError<E>>

Checks the CRC of eight bytes read off the bus and keeps them as a ROM code.

§Arguments
  • bytes - the eight bytes in bus order.
§Returns

The ROM code.

§Errors

Returns OneWireError::Crc if the last byte is not the CRC-8 of the first seven.

Source

pub fn bytes(&self) -> [u8; 8]

Returns the eight bytes in bus order.

Source

pub fn family(&self) -> u8

Returns the family code, the first byte.

Source

pub fn serial(&self) -> u64

Returns the 48-bit serial number.

Source

pub fn crc(&self) -> u8

Returns the CRC byte.

Trait Implementations§

Source§

impl Clone for RomCode

Source§

fn clone(&self) -> RomCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RomCode

Source§

impl Debug for RomCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RomCode

Source§

impl Hash for RomCode

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RomCode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RomCode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.