Struct linuxcnc_hal::HalComponentBuilder

pub struct HalComponentBuilder { /* fields omitted */ }

HAL component builder

Create a new HAL component with HalComponentBuilder::new. Use the builder to register a component with LinuxCNC. Once created, pins can be registered to the component. Finally, call builder.ready() to consume the builder and create a HalComponent ready for use in the component main loop.

Methods

impl HalComponentBuilder

pub fn new(name: &'static str) -> Result<Self, ComponentInitError>

Create a new HAL component builder and begin initialisation

Safety

This calls hal_init internally, which may panic or leak memory.

Errors

This component will error if the component name is longer than HAL_NAME_LEN, the name cannot be converted to a valid CString or the call to hal_init returns an invalid ID.

pub fn register_input_pin<P>(
    &mut self,
    pin_name: &'static str
) -> Result<InputPin<P>, PinRegisterError> where
    P: HalPin + 'static, 

Register an input pin with this component

The pin name will be prefixed with the component name

pub fn register_output_pin<P>(
    &mut self,
    pin_name: &'static str
) -> Result<OutputPin<P>, PinRegisterError> where
    P: HalPin + 'static, 

Register an output pin with this component

The pin name will be prefixed with the component name

pub fn ready(self) -> Result<HalComponent, ComponentReadyError>

Consume the builder and signal that the component is ready

This method is called after any pins are registered and consumes the builder into a HalComponent.

Safety

This method calls the unsafe hal_ready method internally.

pub fn id(&self) -> i32

Get the HAL-assigned ID for this component

pub fn name(&self) -> &str

Get the component name

Trait Implementations

impl Debug for HalComponentBuilder

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

Formats the value using the given formatter.

impl PartialEq<HalComponentBuilder> for HalComponentBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for HalComponentBuilder