Struct BitTimingBuilder

Source

pub struct BitTimingBuilder { /* private fields */ }

Expand description

Builder for creating BitTiming programmatically.

This builder allows you to construct bit timing configuration when building DBC files programmatically.

§Examples

use dbc_rs::BitTimingBuilder;

// Empty bit timing (most common)
let bt = BitTimingBuilder::new().build()?;
assert!(bt.is_empty());

// With baudrate only
let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .build()?;
assert_eq!(bt.baudrate(), Some(500000));

// With full timing parameters
let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .btr1(1)
    .btr2(2)
    .build()?;

§Feature Requirements

This builder requires the std feature to be enabled.

Implementations§

Source §

impl BitTimingBuilder

Source

pub fn build(self) -> Result<BitTiming>

Builds the BitTiming from this builder.

§Returns

Returns Ok(BitTiming) with the configured values. Returns an empty BitTiming if no values were set.

§Examples

use dbc_rs::BitTimingBuilder;

let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .btr1(1)
    .btr2(2)
    .build()?;

assert_eq!(bt.baudrate(), Some(500000));
assert_eq!(bt.btr1(), Some(1));
assert_eq!(bt.btr2(), Some(2));

Source §

impl BitTimingBuilder

Source

pub fn new() -> Self

Creates a new BitTimingBuilder with no values set.

§Examples

use dbc_rs::BitTimingBuilder;

let builder = BitTimingBuilder::new();
let bt = builder.build()?;
assert!(bt.is_empty());

Source

pub fn baudrate(self, baudrate: u32) -> Self

Sets the baudrate in bits per second.

§Arguments

baudrate - The CAN bus baudrate (e.g., 500000 for 500 kbps)

§Examples

use dbc_rs::BitTimingBuilder;

let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .build()?;
assert_eq!(bt.baudrate(), Some(500000));

Source

pub fn btr1(self, btr1: u32) -> Self

Sets the Bus Timing Register 1 (BTR1) value.

BTR1 is typically only meaningful when baudrate is also set.

§Arguments

btr1 - The BTR1 register value

§Examples

use dbc_rs::BitTimingBuilder;

let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .btr1(1)
    .build()?;
assert_eq!(bt.btr1(), Some(1));

Source

pub fn btr2(self, btr2: u32) -> Self

Sets the Bus Timing Register 2 (BTR2) value.

BTR2 is typically only meaningful when baudrate and BTR1 are also set.

§Arguments

btr2 - The BTR2 register value

§Examples

use dbc_rs::BitTimingBuilder;

let bt = BitTimingBuilder::new()
    .baudrate(500000)
    .btr1(1)
    .btr2(2)
    .build()?;
assert_eq!(bt.btr2(), Some(2));