ragout_assistant 0.1.1

Internal/backend crate for the ragout crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

pub mod input;

use std::io::StdoutLock;

pub use input::init;
pub use input::{History, Input};

// this trait can be implemented be it at the ragout lib or ragout_custom_events macro, once
// InputAction has been defined,
// NOTE: if this is not implemented, input.write() also can't be implemented
/// Implement for types that you want to have a debug log for.
/// Implemented for Input and History in the ragout crate
/// # Object Safety
///
/// This trait is [`Object safe`]("https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety")
pub trait DebugLog<E> {
    fn log(&mut self, event: &E);

    fn dl_rfd(&self) -> i32;
}

/// Implements the write method which takes an event and reacts to it.
/// # Object Safety
///
/// This trait is [`Object safe`]("https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety")
pub trait Writer<E> {
    fn write(&mut self, h: &mut History, ia: &E, sol: &mut StdoutLock<'_>, ui: &mut String);
}