Struct nvim_oxi::api::Buffer

pub struct Buffer(_);

A newtype struct wrapping a Neovim buffer. All the nvim_buf_* functions taking a buffer handle as their first argument are implemented as methods on this object.

Implementations

impl Buffer

pub fn current() -> Self

Shorthand for nvim_oxi::api::get_current_buf.

pub fn attach(&self, send_buffer: bool, opts: &BufAttachOpts) -> Result<()>

Binding to nvim_buf_attach.

Used to register a set of callbacks on specific buffer events.

pub fn call<F, R>(&self, fun: F) -> Result<R> where
    F: FnOnce(()) -> Result<R> + 'static,
    R: ToObject + FromObject, 

Binding to nvim_buf_call.

Calls a function with this buffer as the temporary current buffer.

pub fn create_user_command<Cmd>(
    &mut self,
    name: &str,
    command: Cmd,
    opts: Option<&CreateCommandOpts>
) -> Result<()> where
    Cmd: StringOrFunction<CommandArgs, ()>, 

Binding to nvim_buf_create_user_command.

Creates a new buffer-local user command.

pub fn del_keymap(&mut self, mode: Mode, lhs: &str) -> Result<()>

Binding to nvim_buf_del_keymap.

Unmaps a buffer-local mapping for the given mode.

pub fn del_mark(&mut self, name: char) -> Result<()>

Binding to nvim_buf_del_mark.

Deletes a named mark in the buffer.

pub fn del_user_command(&mut self, name: &str) -> Result<()>

Binding to nvim_buf_del_user_command.

Deletes a buffer-local user-command. Use api::del_user_command to delete a global command.

pub fn del_var(&mut self, name: &str) -> Result<()>

Binding to nvim_buf_del_var.

Removes a buffer-scoped (b:) variable.

pub fn delete(self, opts: Option<&BufDeleteOpts>) -> Result<()>

Binding to nvim_buf_delete.

Deletes the buffer (not allowed while textlock is active).

pub fn get_changedtick(&self) -> Result<u32>

Binding to nvim_buf_get_changedtick.

pub fn get_commands(
    &self,
    opts: Option<&GetCommandsOpts>
) -> Result<impl SuperIterator<CommandInfos>>

Binding to nvim_buf_get_commands.

pub fn get_keymap(&self, mode: Mode) -> Result<impl SuperIterator<KeymapInfos>>

Binding to nvim_buf_get_keymap.

pub fn get_lines(
    &self,
    start: usize,
    end: usize,
    strict_indexing: bool
) -> Result<impl SuperIterator<String>>

Binding to nvim_buf_get_lines.

Gets a line range from the buffer. Indexing is zero-based, end-exclusive. Out of bounds indices are clamped to the nearest valid value, unless strict_indexing is set, in which case passing an invalid index will cause an error.

pub fn get_mark(&self, name: char) -> Result<(usize, usize)>

Binding to nvim_buf_get_mark.

Returns a (1-0) indexed (row, col) tuple representing the position of the named mark.

pub fn get_name(&self) -> Result<PathBuf>

Binding to nvim_buf_get_name.

Returns the full filepath of the buffer.

pub fn get_offset(&self, index: usize) -> Result<usize>

Binding to nvim_buf_get_offset.

Returns the 0-indexed byte offset of a line.

pub fn get_option<Opt>(&self, name: &str) -> Result<Opt> where
    Opt: FromObject, 

Binding to nvim_buf_get_option.

Gets a buffer option value.

pub fn get_text(
    &self,
    start_row: usize,
    start_col: usize,
    end_row: usize,
    end_col: usize,
    opts: Option<&GetTextOpts>
) -> Result<impl SuperIterator<String>>

Binding to nvim_buf_get_text.

Gets a range from the buffer. This differs from Buffer::get_lines in that it allows retrieving only portions of a line.

Indexing is zero-based, with both row and column indices being end-exclusive.

pub fn get_var<Var>(&self, name: &str) -> Result<Var> where
    Var: FromObject, 

Binding to nvim_buf_get_var.

Gets a buffer-scoped (b:) variable.

pub fn is_loaded(&self) -> bool

Binding to nvim_buf_is_loaded.

Checks if a buffer is valid and loaded.

pub fn is_valid(&self) -> bool

Binding to nvim_buf_is_valid.

Checks if a buffer is valid.

pub fn line_count(&self) -> Result<usize>

Binding to nvim_buf_line_count.

Returns the number of lines in the given buffer.

pub fn set_keymap(
    &mut self,
    mode: Mode,
    lhs: &str,
    rhs: &str,
    opts: Option<&SetKeymapOpts>
) -> Result<()>

Binding to nvim_buf_set_keymap.

Sets a buffer-local mapping for the given mode. To set a global mapping use api::set_keymap instead.

pub fn set_lines<Line, Lines>(
    &mut self,
    start: usize,
    end: usize,
    strict_indexing: bool,
    replacement: Lines
) -> Result<()> where
    Lines: IntoIterator<Item = Line>,
    Line: Into<String>, 

Binding to nvim_buf_set_lines.

Sets (replaces) a line-range in the buffer. Indexing is zero-based, end-exclusive.

pub fn set_mark(&mut self, name: char, line: usize, col: usize) -> Result<()>

Binding to nvim_buf_set_mark.

Sets a named mark in the buffer. Marks are (1,0)-indexed, and passing 0 as line deletes the mark.

pub fn set_name<Name: AsRef<Path>>(&mut self, name: Name) -> Result<()>

Binding to nvim_buf_set_name.

Sets the full file name for a buffer.

pub fn set_option<V>(&mut self, name: &str, value: V) -> Result<()> where
    V: ToObject, 

Binding to nvim_buf_set_option.

Sets a buffer option value. Passing None as value deletes the option (only works if there’s a global fallback).

pub fn set_text<Line, Lines>(
    &mut self,
    start_row: usize,
    start_col: usize,
    end_row: usize,
    end_col: usize,
    replacement: Lines
) -> Result<()> where
    Lines: IntoIterator<Item = Line>,
    Line: Into<String>, 

Binding to nvim_buf_set_text.

Sets (replaces) a range in the buffer. Indexing is zero-based, with both row and column indices being end-exclusive.

pub fn set_var<V>(&mut self, name: &str, value: V) -> Result<()> where
    V: ToObject, 

Binding to nvim_buf_set_var.

Sets a buffer-scoped (b:) variable.

impl Buffer

pub fn add_highlight<I, L, S, E>(
    &mut self,
    ns_id: I,
    hl_group: &str,
    line: L,
    col_start: S,
    col_end: E
) -> Result<i64> where
    I: Into<Integer>,
    L: Into<Integer>,
    S: Into<Integer>,
    E: Into<Integer>, 

Binding to nvim_buf_add_highlight.

Adds a highlight to the buffer. line, col_start and col_end are all 0-indexed. You can also pass -1 to col_end to highlight to end of line.

pub fn clear_namespace(
    &mut self,
    ns_id: u32,
    line_start: usize,
    line_end: usize
) -> Result<()>

Binding to nvim_buf_clear_namespace.

Clears namespaced objects like highlights, extmarks, or virtual text from a region.

Lines are 0-indexed. It’s possible to clear the namespace in the entire buffer by specifying line_start = 0 and line_end = -1.

pub fn del_extmark(&mut self, ns_id: u32, extmark_id: u32) -> Result<()>

Binding to nvim_buf_del_extmark.

Removes an extmark from the buffer.

pub fn get_extmark_by_id(
    &self,
    ns_id: u32,
    extmark_id: u32,
    opts: Option<&GetExtmarkByIdOpts>
) -> Result<(usize, usize, Option<ExtmarkInfos>)>

Binding to nvim_buf_get_extmark_by_id.

The first two elements of the returned tuple represent the 0-indexed row, col position of the extmark. The last element is only present if the details option field was set to true.

pub fn get_extmarks(
    &self,
    ns_id: u32,
    start: ExtmarkPosition,
    end: ExtmarkPosition,
    opts: Option<&GetExtmarksOpts>
) -> Result<impl SuperIterator<(u32, usize, usize, Option<ExtmarkInfos>)>>

Bindings to nvim_buf_get_extmarks.

Gets all the extmarks in a buffer region specified by start and end positions. Returns an iterator over (extmark_id, row, col, infos) tuples in “traversal order”. Like for Buffer::get_extmark_by_id, the infos are present only if the details option field was set to true.

pub fn set_extmark(
    &mut self,
    ns_id: u32,
    line: usize,
    col: usize,
    opts: Option<&SetExtmarkOpts>
) -> Result<u32>

Binding to nvim_buf_set_extmark.

Creates or updates an extmark. Both line and col are 0-indexed. Returns the id of the created/updated extmark.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Buffer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Buffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&Buffer> for Object

fn from(buf: &Buffer) -> Self

Converts to this type from the input type.

impl From<Buffer> for Object

fn from(buf: Buffer) -> Self

Converts to this type from the input type.

impl<H: Into<BufHandle>> From<H> for Buffer

fn from(handle: H) -> Self

Converts to this type from the input type.

impl FromObject for Buffer

fn from_obj(obj: Object) -> Result<Self>

impl Hash for Buffer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Buffer> for Buffer

fn eq(&self, other: &Buffer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Buffer) -> bool

This method tests for !=.

impl Serialize for Buffer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Buffer

impl StructuralEq for Buffer

impl StructuralPartialEq for Buffer