vimvar

Crates.iovimvar
lib.rsvimvar
version0.3.0
sourcesrc
created_at2021-05-30 04:47:47.634883
updated_at2022-04-17 20:44:06.740638
descriptionLibrary that provides ability to read neovim/vim variables
homepagehttps://github.com/chipsenkbeil/vimvar-rs
repositoryhttps://github.com/chipsenkbeil/vimvar-rs
max_upload_size
id403736
size50,182
Chip Senkbeil (chipsenkbeil)

documentation

README

vimvar-rs: Library to read neovim/vim variables from Rust

Build Status Crates.io Docs.rs


Installation

# Cargo.toml
[dependencies]
vimvar = "0.3"

Usage

// Loads g:my_global_var from default vimrc, returning None if it does not
// exist, and casting to type String from the default serde_json::Value
//
// Only fails unwrap if neovim/vim fails to run or type fails to cast
let var: Option<String> = vimvar::load_typed_global_var("my_global_var").unwrap();
println!("Loaded g:my_global_var = {:?}", var);

For more a more explicit example

use vimvar::*;
use serde_json::json;

// Load explicitly a buffer variable (b:my_buffer_var) using neovim
let var = VimVar::new(Cmd::NeoVim, Scope::Buffer, "my_buffer_var");

// Load the variable using a different config file versus the standard one
let value = var.load_with_config("path/to/config.vim", false).expect("Failed to load variable");
assert_eq!(value, Some(json!("some buffer value")));

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in vimvar by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 20

cargo fmt