Struct Skim 

pub struct Skim {}

Main entry point for running skim

Implementations

impl Skim

pub fn run_with( options: SkimOptions, source: Option<SkimItemReceiver>, ) -> Result<SkimOutput>

Params

• options: the “complex” options that control how skim behaves
• source: a stream of items to be passed to skim for filtering. If None is given, skim will invoke the command given to fetch the items.

Returns

• None: on internal errors.
• SkimOutput: the collected key, event, query, selected items, etc.

Panics

Panics if the tui fails to initilize

Examples found in repository

examples/sample.rs (line 7)

pub fn main() {
    let options = SkimOptions::default();

    let selected_items = Skim::run_with(options, None)
        .map(|out| out.selected_items)
        .unwrap_or_default();

    for item in selected_items.iter() {
        println!("{}", item.output());
    }
}

examples/receiver_multi.rs (lines 12-18)

fn main() {
    let (sender, receiver) = unbounded::<Arc<dyn SkimItem>>();
    for num in 1..=8 {
        sender.send(Arc::new(format!("Option {num}"))).unwrap();
    }
    drop(sender); // bug replicates even without this

    let _ = Skim::run_with(
        SkimOptions {
            multi: true,
            ..Default::default()
        },
        Some(receiver),
    );
}

examples/selector.rs (line 25)

pub fn main() {
    let selector = BasicSelector {
        pat: String::from("examples"),
    };
    let options = SkimOptionsBuilder::default()
        .multi(true)
        .selector(Some(Rc::from(selector)))
        .query(Some(String::from("skim/")))
        .build()
        .unwrap();

    let selected_items = Skim::run_with(options, None)
        .map(|out| out.selected_items)
        .unwrap_or_default();

    for item in selected_items.iter() {
        println!("{}", item.output());
    }
}

examples/cmd_collector.rs (line 41)

fn main() {
    let cmd_collector = BasicCmdCollector {
        items: vec![String::from("foo"), String::from("bar"), String::from("baz")],
    };
    let options = SkimOptionsBuilder::default()
        .cmd_collector(Rc::from(RefCell::from(cmd_collector)))
        .build()
        .unwrap();

    let selected_items = Skim::run_with(options, None)
        .map(|out| out.selected_items)
        .unwrap_or_default();

    for item in selected_items.iter() {
        println!("{}", item.output());
    }
}

examples/nth.rs (line 17)

pub fn main() {
    let input = "foo 123";

    let options = SkimOptionsBuilder::default()
        .query(Some(String::from("f")))
        .build()
        .unwrap();
    let item_reader = SkimItemReader::new(SkimItemReaderOption::default().nth(vec!["2"].into_iter()).build());

    let items = item_reader.of_bufread(Cursor::new(input));
    let selected_items = Skim::run_with(options, Some(items))
        .map(|out| out.selected_items)
        .unwrap_or_default();

    for item in selected_items.iter() {
        println!("{}", item.output());
    }
}

examples/preview_callback.rs (line 21)

pub fn main() {
    env_logger::init();
    let options = SkimOptionsBuilder::default()
        .multi(true)
        .preview_fn(Some(PreviewCallback::from(|items: Vec<Arc<dyn SkimItem>>| {
            items
                .iter()
                .map(|s| s.text().to_ascii_uppercase().into())
                .collect::<Vec<_>>()
        })))
        .build()
        .unwrap();
    let item_reader = SkimItemReader::default();

    let input = "aaaaa\nbbbb\nccc";
    let items = item_reader.of_bufread(Cursor::new(input));
    let selected_items = Skim::run_with(options, Some(items))
        .map(|out| out.selected_items)
        .unwrap_or_default();

    for item in selected_items.iter() {
        println!("{}", item.output());
    }
}

Additional examples can be found in:

• examples/ansi.rs
• examples/custom_keybinding_actions.rs
• examples/custom_item.rs
• examples/downcast.rs
• examples/option_builder.rs