Struct Terminal 

pub struct Terminal<'a, E: Copy + Debug> { /* private fields */ }

A place where a device can connect to another.

Implementations

impl<E: Copy + Debug> Terminal<'_, E>

pub const fn new_raw() -> Self

Direct constructor for a Terminal. You almost always actually want RefCell<Terminal> however, in which case you should call new, which returns RefCell<Terminal>.

pub const fn new() -> RefCell<Self>

This constructs a RefCell<Terminal>. This is almost always what you want, and what is needed for connecting terminals. If you do just want a Terminal, use new_raw instead.

pub fn disconnect(&mut self)

Disconnect this terminal and the one that it is connected to. You can connect terminals by calling the rrtk::connect function.

Trait Implementations

impl<E: Copy + Debug> Getter<Command, E> for Terminal<'_, E>

fn get(&self) -> Output<Command, E>

Get something.

impl<E: Copy + Debug> Getter<State, E> for Terminal<'_, E>

fn get(&self) -> Output<State, E>

Get something.

impl<E: Copy + Debug> Getter<TerminalData, E> for Terminal<'_, E>

fn get(&self) -> Output<TerminalData, E>

Get something.

impl<E: Copy + Debug> Settable<Datum<Command>, E> for Terminal<'_, E>

fn get_settable_data_ref(&self) -> &SettableData<Datum<Command>, E>

As traits cannot have fields, get functions and separate types are required. All you have to do is make a field for a corresponding SettableData, make this return an immutable reference to it, and make get_settable_data_mut return a mutable reference to it.

fn get_settable_data_mut(&mut self) -> &mut SettableData<Datum<Command>, E>

As traits cannot have fields, get functions and separate types are required. All you have to do is make a field for a corresponding SettableData, make this return a mutable reference to it, and make get_settable_data_ref return an immutable reference to it.

fn impl_set(&mut self, _command: Datum<Command>) -> NothingOrError<E>

Set something, not updating the internal SettableData. Due to current limitations of the language, you must implement this but call set. Do not call this directly as it will make get_last_request work incorrectly.

fn set(&mut self, value: S) -> NothingOrError<E>

Set something to a value. For example, this could set a motor to a voltage. You should call this and not impl_set.

fn follow(&mut self, getter: Reference<dyn Getter<S, E>>)

Begin following a Getter of the same type. For this to work, you must have update_following_data in your Updatable implementation.

fn stop_following(&mut self)

Stop following the Getter.

fn update_following_data(&mut self) -> NothingOrError<E>

Get a new value from the Getter we’re following, if there is one, and call set accordingly. You must add this to your Updatable implementation if you are following Getters. This is a current limitation of the Rust language. If specialization is ever stabilized, this will hopefully be done in a better way.

fn get_last_request(&self) -> Option<S>

Get the argument from the last time set was called.

impl<E: Copy + Debug> Settable<Datum<State>, E> for Terminal<'_, E>

fn get_settable_data_ref(&self) -> &SettableData<Datum<State>, E>

As traits cannot have fields, get functions and separate types are required. All you have to do is make a field for a corresponding SettableData, make this return an immutable reference to it, and make get_settable_data_mut return a mutable reference to it.

fn get_settable_data_mut(&mut self) -> &mut SettableData<Datum<State>, E>

As traits cannot have fields, get functions and separate types are required. All you have to do is make a field for a corresponding SettableData, make this return a mutable reference to it, and make get_settable_data_ref return an immutable reference to it.

fn impl_set(&mut self, _state: Datum<State>) -> NothingOrError<E>

Set something, not updating the internal SettableData. Due to current limitations of the language, you must implement this but call set. Do not call this directly as it will make get_last_request work incorrectly.

fn set(&mut self, value: S) -> NothingOrError<E>

Set something to a value. For example, this could set a motor to a voltage. You should call this and not impl_set.

fn follow(&mut self, getter: Reference<dyn Getter<S, E>>)

Begin following a Getter of the same type. For this to work, you must have update_following_data in your Updatable implementation.

fn stop_following(&mut self)

Stop following the Getter.

fn update_following_data(&mut self) -> NothingOrError<E>

Get a new value from the Getter we’re following, if there is one, and call set accordingly. You must add this to your Updatable implementation if you are following Getters. This is a current limitation of the Rust language. If specialization is ever stabilized, this will hopefully be done in a better way.

fn get_last_request(&self) -> Option<S>

Get the argument from the last time set was called.

impl<E: Copy + Debug> Updatable<E> for Terminal<'_, E>

fn update(&mut self) -> NothingOrError<E>

As this trait is very generic, exactly what this does will be very dependent on the implementor.