Struct noline::builder::EditorBuilder

pub struct EditorBuilder<B: Buffer, H: History> { /* private fields */ }

Builder for sync::Editor and no_sync::tokio::Editor.

Example

use noline::builder::EditorBuilder;

let mut editor = EditorBuilder::new_static::<100>()
    .with_static_history::<200>()
    .build_sync(&mut io)
    .unwrap();

Implementations

impl EditorBuilder<NoBuffer, NoHistory>

pub fn new_static<const N: usize>() -> EditorBuilder<StaticBuffer<N>, NoHistory>

Create builder for editor with static buffer

Example

use noline::builder::EditorBuilder;

let builder = EditorBuilder::new_static::<100>();

pub fn new_unbounded() -> EditorBuilder<UnboundedBuffer, NoHistory>

Create builder for editor with unbounded buffer

Example

use noline::builder::EditorBuilder;

let builder = EditorBuilder::new_unbounded();

impl<B: Buffer, H: History> EditorBuilder<B, H>

pub fn with_static_history<const N: usize>( self, ) -> EditorBuilder<B, StaticHistory<N>>

Add static history

pub fn with_unbounded_history(self) -> EditorBuilder<B, UnboundedHistory>

Add unbounded history

pub fn build_sync<IO, RE, WE>( self, io: &mut IO, ) -> Result<Editor<B, H, IO>, Error<RE, WE>>

where IO: Read<Error = RE> + Write<Error = WE>,

Build sync::Editor. Is equivalent of calling sync::Editor::new().

pub async fn build_async_tokio<W: AsyncWriteExt + Unpin, R: AsyncReadExt + Unpin>( self, stdin: &mut R, stdout: &mut W, ) -> Result<Editor<B, H>, Error<Error, Error>>

Build no_sync::tokio::Editor. Is equivalent of calling no_sync::tokio::Editor::new().