Struct ProtocolVersion 

pub struct ProtocolVersion { /* private fields */ }

Describes the semantic version of this implementation of the NBMC interface.

Implementations

impl ProtocolVersion

pub const fn new(major: u8, minor: u8, patch: u8) -> ProtocolVersion

Construct a new ProtocolVersion.

This isn’t a message but instead can form part of a message. For example, you should have a register address which provides the version of the NBMC protocol implemented.

Pass in the major version, the minor version and the patch version.

pub const fn is_compatible_with(&self, my_version: &ProtocolVersion) -> bool

Check if this ProtocolVersion is compatible with my_version.

let my_version = ProtocolVersion::new(1, 1, 0);

// This is compatible.
let bmc_a = ProtocolVersion::new(1, 1, 1);
assert!(bmc_a.is_compatible_with(&my_version));

// This is incompatible - patch is too low.
let bmc_b = ProtocolVersion::new(1, 0, 0);
assert!(!bmc_b.is_compatible_with(&my_version));

// This is incompatible - major is too high.
let bmc_c = ProtocolVersion::new(2, 0, 0);
assert!(!bmc_c.is_compatible_with(&my_version));

// This is incompatible - major is too low.
let bmc_d = ProtocolVersion::new(0, 1, 0);
assert!(!bmc_d.is_compatible_with(&my_version));

pub const fn as_bytes(&self) -> [u8; 3]

Convert to bytes for transmission.

Trait Implementations

impl Clone for ProtocolVersion

fn clone(&self) -> ProtocolVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolVersion

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

Formats the value using the given formatter.

impl PartialEq for ProtocolVersion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sendable for ProtocolVersion

fn render_to_buffer(&self, buffer: &mut [u8]) -> Result<usize, Error>

Convert to bytes for transmission.

impl Copy for ProtocolVersion

impl Eq for ProtocolVersion

impl StructuralPartialEq for ProtocolVersion