Struct FzfBuilder

pub struct FzfBuilder { /* private fields */ }

Builder for Fzf.

Implementations

impl FzfBuilder

pub fn scheme<VALUE: Into<Scheme>>(&mut self, value: VALUE) -> &mut Self

Scoring scheme

pub fn literal<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Do not normalize latin script letters before matching

pub fn track<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Track the current selection when the result is updated

pub fn tac<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Reverse the order of the input

pub fn disabled<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Do not perform search

pub fn no_mouse<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Disable mouse

pub fn cycle<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Enable cyclic scroll

pub fn keep_right<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Keep the right end of the line visible on overflow

pub fn no_hscroll<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Disable horizontal scroll

pub fn filepath_word<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Make word-wise movements respect path separators

pub fn layout<VALUE: Into<Layout>>(&mut self, value: VALUE) -> &mut Self

Choose layout

Examples found in repository

examples/color.rs (line 11)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn border<VALUE: Into<Border>>(&mut self, value: VALUE) -> &mut Self

Draw border around the finder

Examples found in repository

examples/color.rs (line 12)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn border_label<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Label to print on the border

Examples found in repository

examples/color.rs (line 13)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn no_separator<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Hide info line separator

pub fn no_scrollbar<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Hide scrollbar

pub fn prompt<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Input prompt (default: ’> ’)

pub fn pointer<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Pointer to the current line (default: ‘>’)

pub fn header<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

String to print as header

Examples found in repository

examples/color.rs (line 15)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn header_first<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Print header before the prompt line

Examples found in repository

examples/color.rs (line 16)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn ansi<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Enable processing of ANSI color codes

pub fn tabstop<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

Number of spaces for a tab character (default: 8)

pub fn color<VALUE: Into<Color>>(&mut self, value: VALUE) -> &mut Self

Base scheme (dark|light|16|bw)

Examples found in repository

examples/color.rs (line 14)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

pub fn no_bold<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Do not use bold text

pub fn build(&self) -> Result<Fzf, FzfBuilderError>

Builds a new Fzf.

Errors

If a required field has not been initialized.

Examples found in repository

examples/color.rs (line 18)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

impl FzfBuilder

pub fn custom_args( &mut self, args: impl IntoIterator<Item = impl Into<String>>, ) -> &mut Self

Additional arguments that this library doesn’t currently support as a predefined option

Examples found in repository

examples/color.rs (line 17)

fn main() {
    let colours = vec![
        "red", "orange", "yellow", "green", "blue", "indigo", "violet",
    ];

    let fzf = Fzf::builder()
        .layout(Layout::Reverse)
        .border(Border::Rounded)
        .border_label("Favourite Colour")
        .color(Color::Bw)
        .header("Pick your favourite colour")
        .header_first(true)
        .custom_args(vec!["--height=10".to_string()])
        .build()
        .unwrap();

    let users_selection = run_with_output(fzf, colours);

    if let Some(colour) = users_selection {
        println!("{} is an awesome colour!", colour);
    }
}

Trait Implementations

impl Clone for FzfBuilder

fn clone(&self) -> FzfBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for FzfBuilder

fn default() -> Self

Returns the “default value” for a type.