Struct Window

pub struct Window(/* private fields */);

A wrapper around a Neovim window handle.

Implementations

impl Window

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

where Opt: FromObject,

Binding to nvim_win_get_option().

Gets a window option value.

pub fn set_option<Opt>(&mut self, name: &str, value: Opt) -> Result<(), Error>

where Opt: ToObject,

Binding to nvim_win_set_option().

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

impl Window

pub fn get_config(&self) -> Result<WindowConfig, Error>

Binding to nvim_win_get_config().

Gets the window configuration.

pub fn set_config(&mut self, config: &WindowConfig) -> Result<(), Error>

Binding to nvim_win_get_config().

Configures the window layout. Only for floating and external windows.

impl Window

pub fn current() -> Self

Shorthand for get_current_win.

pub fn handle(&self) -> i32

Retrieve window’s underlying id/handle

pub fn call<F, Res, Ret>(&self, fun: F) -> Result<Ret, Error>

where F: FnOnce(()) -> Res + 'static, Res: IntoResult<Ret>, Res::Error: StdError + 'static, Ret: Pushable + FromObject,

Binding to nvim_win_call().

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

pub fn close(self, force: bool) -> Result<(), Error>

Binding to nvim_win_close().

Closes the window. Not allowed when textlock is active.

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

Binding to nvim_win_del_var().

Removes a window-scoped (w:) variable.

pub fn get_buf(&self) -> Result<Buffer, Error>

Binding to nvim_win_get_buf().

Gets the current Buffer in the window.

pub fn get_cursor(&self) -> Result<(usize, usize), Error>

Binding to nvim_win_get_cursor().

Gets the (1,0)-indexed cursor position in the window.

pub fn get_height(&self) -> Result<u32, Error>

Binding to nvim_win_get_height().

Gets the window height as a count of rows.

pub fn get_number(&self) -> Result<u32, Error>

Binding to nvim_win_get_number().

Gets the window number.

pub fn get_position(&self) -> Result<(usize, usize), Error>

Binding to nvim_win_get_position().

Gets the window position in display cells.

pub fn get_tabpage(&self) -> Result<TabPage, Error>

Binding to nvim_win_get_tabpage().

Gets the window’s TabPage.

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

where Var: FromObject,

Binding to nvim_win_get_var().

Gets a window-scoped (w:) variable.

pub fn get_width(&self) -> Result<u32, Error>

Binding to nvim_win_get_width().

Gets the window width as a number of columns.

pub fn hide(self) -> Result<(), Error>

Binding to nvim_win_hide().

Closes the window and hides the buffer it contains.

pub fn is_valid(&self) -> bool

Binding to nvim_win_is_valid().

Checks if the window is valid.

pub fn set_buf(&mut self, buffer: &Buffer) -> Result<(), Error>

Binding to nvim_win_set_buf().

Sets buffer as the current buffer in the window.

pub fn set_cursor(&mut self, line: usize, col: usize) -> Result<(), Error>

Binding to nvim_win_set_cursor().

Sets the (1,0)-indexed cursor in the window. This will scroll the window even if it’s not the current one.

pub fn set_height(&mut self, height: u32) -> Result<(), Error>

Binding to nvim_win_set_height().

Sets the window height.

pub fn set_hl_ns(&mut self, ns_id: u32) -> Result<(), Error>

Binding to nvim_win_set_hl_ns().

Sets the highlight namespace for this window. This will the highlights defined with set_hl for the given namespace, but fall back to global highlights (ns_id = 0) if those are missing.

This takes precedence over the winhighlight option.

pub fn set_var<Var>(&mut self, name: &str, value: Var) -> Result<(), Error>

where Var: ToObject,

Binding to nvim_win_set_var().

Sets a window-scoped (w:) variable.

pub fn set_width(&mut self, width: u32) -> Result<(), Error>

Binding to nvim_win_set_width().

Sets the window width.

pub fn text_height( &self, opts: &WinTextHeightOpts, ) -> Result<WinTextHeightInfos, Error>

Binding to nvim_win_text_height().

Computes the number of screen lines occupied by a range of text in a given window. Works for off-screen text and takes folds into account.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Window

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Window

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

Formats the value using the given formatter.

impl From<&Window> for Object

fn from(win: &Window) -> Self

Converts to this type from the input type.

impl<H: Into<WinHandle>> From<H> for Window

fn from(handle: H) -> Self

Converts to this type from the input type.

impl From<Window> for Object

fn from(win: Window) -> Self

Converts to this type from the input type.

impl FromObject for Window

fn from_object(obj: Object) -> StdResult<Self, Error>

impl Hash for Window

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Window

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Poppable for Window

unsafe fn pop(lstate: *mut State) -> Result<Self, Error>

Pops the value at the top of the stack.

impl Pushable for Window

unsafe fn push(self, lstate: *mut State) -> Result<c_int, Error>

Pushes all its values on the Lua stack, returning the number of values that it pushed.

impl Serialize for Window

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 Window

impl StructuralPartialEq for Window