var searchIndex = {}; searchIndex["rustyline"] = {"doc":"Readline for Rust","items":[[3,"Editor","rustyline","Line editor",null,null],[0,"completion","","Completion API",null,null],[3,"FilenameCompleter","rustyline::completion","",null,null],[5,"extract_word","","",null,null],[8,"Completer","","To be called for tab-completion.",null,null],[10,"complete","","Takes the currently edited `line` with the cursor `pos`ition and\nreturns the start position and the completion candidates for the partial word to be completed.\n"ls /usr/loc" => Ok((3, vec!["/usr/local/"]))",0,null],[11,"update","","Updates the edited `line` with the `elected` candidate.",0,null],[11,"new","","",1,{"inputs":[],"output":{"name":"filenamecompleter"}}],[11,"default","","",1,{"inputs":[],"output":{"name":"filenamecompleter"}}],[11,"complete","","",1,null],[0,"error","rustyline","Contains error type for handling I/O and Errno errors",null,null],[4,"ReadlineError","rustyline::error","The error type for Rustyline errors that can arise from\nI/O related errors or Errno when using the nix-rust library",null,null],[13,"Io","","I/O Error",2,null],[13,"Errno","","Error from syscall",2,null],[13,"Char","","Chars Error",2,null],[13,"Eof","","EOF (Ctrl-d)",2,null],[13,"Interrupted","","Ctrl-C",2,null],[11,"fmt","","",2,null],[11,"fmt","","",2,null],[11,"description","","",2,null],[11,"from","","",2,{"inputs":[{"name":"error"}],"output":{"name":"readlineerror"}}],[11,"from","","",2,{"inputs":[{"name":"error"}],"output":{"name":"readlineerror"}}],[11,"from","","",2,{"inputs":[{"name":"charserror"}],"output":{"name":"readlineerror"}}],[0,"history","rustyline","History API",null,null],[3,"History","rustyline::history","",null,null],[11,"new","","",3,{"inputs":[],"output":{"name":"history"}}],[11,"get","","Return the history entry at position `index`, starting from 0.",3,null],[11,"add","","Add a new entry in the history.",3,null],[11,"len","","Returns the number of entries in the history.",3,null],[11,"is_empty","","Returns true if the history has no entry.",3,null],[11,"set_max_len","","Set the maximum length for the history. This function can be called even\nif there is already some history, the function will make sure to retain\njust the latest `len` elements if the new history length value is smaller\nthan the amount of items already inside the history.",3,null],[11,"save","","Save the history in the specified file.",3,null],[11,"load","","Load the history from the specified file.",3,null],[11,"clear","","Clear history",3,null],[11,"search","","Search history (start position inclusive [0, len-1])",3,null],[11,"default","","",3,{"inputs":[],"output":{"name":"history"}}],[0,"line_buffer","rustyline","Line buffer with current cursor position",null,null],[3,"LineBuffer","rustyline::line_buffer","",null,null],[4,"WordAction","","",null,null],[13,"CAPITALIZE","","",4,null],[13,"LOWERCASE","","",4,null],[13,"UPPERCASE","","",4,null],[7,"MAX_LINE","","Maximum buffer size for the line read",null,null],[11,"fmt","","",5,null],[11,"with_capacity","","Create a new line buffer with the given maximum `capacity`.",5,{"inputs":[{"name":"usize"}],"output":{"name":"linebuffer"}}],[11,"as_str","","Extracts a string slice containing the entire buffer.",5,null],[11,"into_string","","Converts a buffer into a `String` without copying or allocating.",5,null],[11,"pos","","Current cursor position (byte position)",5,null],[11,"len","","Returns the length of this buffer, in bytes.",5,null],[11,"is_empty","","Returns `true` if this buffer has a length of zero.",5,null],[11,"update","","Set line content (`buf`) and cursor position (`pos`).",5,null],[11,"backup","","Backup `src`",5,null],[11,"insert","","Insert the character `ch` at current cursor position\nand advance cursor position accordingly.\nReturn `None` when maximum buffer size has been reached,\n`true` when the character has been appended to the end of the line.",5,null],[11,"yank","","Yank/paste `text` at current position.\nReturn `None` when maximum buffer size has been reached,\n`true` when the character has been appended to the end of the line.",5,null],[11,"yank_pop","","Delete previously yanked text and yank/paste `text` at current position.",5,null],[11,"move_left","","Move cursor on the left.",5,null],[11,"move_right","","Move cursor on the right.",5,null],[11,"move_home","","Move cursor to the start of the line.",5,null],[11,"move_end","","Move cursor to the end of the line.",5,null],[11,"delete","","Delete the character at the right of the cursor without altering the cursor\nposition. Basically this is what happens with the "Delete" keyboard key.",5,null],[11,"backspace","","Delete the character at the left of the cursor.\nBasically that is what happens with the "Backspace" keyboard key.",5,null],[11,"kill_line","","Kill the text from point to the end of the line.",5,null],[11,"discard_line","","Kill backward from point to the beginning of the line.",5,null],[11,"transpose_chars","","Exchange the char before cursor with the character at cursor.",5,null],[11,"move_to_prev_word","","Moves the cursor to the beginning of previous word.",5,null],[11,"delete_prev_word","","Delete the previous word, maintaining the cursor at the start of the\ncurrent word.",5,null],[11,"next_word_pos","","Returns the position (start, end) of the next word.",5,null],[11,"move_to_next_word","","Moves the cursor to the end of next word.",5,null],[11,"delete_word","","Kill from the cursor to the end of the current word, or, if between words, to the end of the next word.",5,null],[11,"edit_word","","Alter the next word.",5,null],[11,"transpose_words","","Transpose two words",5,null],[11,"replace","","Replaces the content between [`start`..`end`] with `text` and positions the cursor to the end of text.",5,null],[11,"deref","","",5,null],[6,"Result","rustyline","The error type for I/O and Linux Syscalls (Errno)",null,null],[11,"new","","",6,{"inputs":[],"output":{"name":"editor"}}],[11,"readline","","This method will read a line from STDIN and will display a `prompt`",6,null],[11,"load_history","","Load the history from the specified file.",6,null],[11,"save_history","","Save the history in the specified file.",6,null],[11,"add_history_entry","","Add a new entry in the history.",6,null],[11,"set_history_max_len","","Set the maximum length for the history.",6,null],[11,"clear_history","","Clear history.",6,null],[11,"get_history","","Return a reference to the history object.",6,null],[11,"set_completer","","Register a callback function to be called for tab-completion.",6,null],[11,"default","","",6,{"inputs":[],"output":{"name":"editor"}}],[11,"fmt","","",6,null]],"paths":[[8,"Completer"],[3,"FilenameCompleter"],[4,"ReadlineError"],[3,"History"],[4,"WordAction"],[3,"LineBuffer"],[3,"Editor"]]}; initSearch(searchIndex);