Struct Control 

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

A data-link control field.

Implementations

impl Control

pub const fn new(value: u8) -> Self

Creates a control field from its wire value.

pub const fn snd_nke() -> Self

Creates an SND-NKE control field.

pub const fn req_ud1(fcb: bool) -> Self

Creates a REQ-UD1 control field with the requested frame-count bit.

pub const fn req_ud2(fcb: bool) -> Self

Creates a REQ-UD2 control field with the requested frame-count bit.

Examples found in repository

examples/request_data_alloc.rs (line 15)

fn main() -> Result<(), ShortFrameError> {
    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;
    let encoded = request.encode();

    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
    Ok(())
}

examples/request_data_no_alloc.rs (line 15)

fn main() -> Result<(), ShortFrameError> {
    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;

    let mut output = [0_u8; ShortFrame::LEN];
    let encoded = request.encode_into(&mut output)?;

    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
    Ok(())
}

pub const fn snd_ud(bit5: bool) -> Self

Creates an SND-UD control field with bit 5 clear or set.

pub const fn snd_ud2() -> Self

Creates an SND-UD2 control field.

pub const fn rsp_ud(acd: bool, dfc: bool) -> Self

Creates an RSP-UD control field with access-demand and data-flow-control flags.

pub const fn value(self) -> u8

Returns the wire value.

pub const fn communication_type(self) -> CommunicationType

Returns the supported communication type represented by this field.

Examples found in repository

examples/decode_exact_alloc.rs (line 22)

fn main() -> Result<(), DecodeError> {
    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;

    if let Frame::Short(short) = &frame {
        assert_eq!(
            short.control().communication_type(),
            CommunicationType::ReqUd2
        );
        assert_eq!(short.address().value(), 1);
    }

    assert_eq!(frame.encode(), [0x10, 0x5b, 0x01, 0x5c, 0x16]);
    Ok(())
}

examples/decode_exact_no_alloc.rs (line 22)

fn main() -> Result<(), DecodeError> {
    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;

    if let Frame::Short(short) = &frame {
        assert_eq!(
            short.control().communication_type(),
            CommunicationType::ReqUd2
        );
        assert_eq!(short.address().value(), 1);
    }

    let mut output = [0_u8; LongFrame::MAX_LEN];
    assert_eq!(
        frame
            .encode_into(&mut output)
            .expect("maximum frame buffer is large enough"),
        [0x10, 0x5b, 0x01, 0x5c, 0x16]
    );

    Ok(())
}

pub const fn direction(self) -> Option<Direction>

Returns the direction of a supported communication.

pub const fn frame_count_bit(self) -> Option<bool>

Returns the frame-count bit for a message sent by a master.

pub const fn frame_count_valid(self) -> Option<bool>

Returns the frame-count-valid bit for a message sent by a master.

pub const fn access_demand(self) -> Option<bool>

Returns the access-demand bit for a message sent by a slave.

pub const fn data_flow_control(self) -> Option<bool>

Returns the data-flow-control bit for a message sent by a slave.

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Control

impl Debug for Control

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

Formats the value using the given formatter.

impl Eq for Control

impl From<u8> for Control

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for Control

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Control

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Control