Struct VimVar

pub struct VimVar<Name: AsRef<str>> { /* private fields */ }

Represents a vim variable to be extracted

Implementations

impl<Name: AsRef<str>> VimVar<Name>

pub fn new(cmd: Cmd, scope: Scope, name: Name) -> Self

Creates a new vim variable definition that can be used later to load the variable’s contents

pub fn cmd(&self) -> Cmd

Returns Cmd tied to variable

pub fn scope(&self) -> Scope

Returns Scope tied to variable

pub fn name(&self) -> &str

Returns name tied to variable

impl<Name: AsRef<str>> VimVar<Name>

pub fn load_typed<T>(&self, allow_zero: bool) -> Result<Option<T>>

where T: DeserializeOwned,

Loads variable with Self::load and then attempts to convert it to the specified type

Notes

• If allow_zero is true, then a value of 0 is considered the value of the variable rather than vim’s default of not being found

pub fn load(&self, allow_zero: bool) -> Result<Option<Value>>

Loads the variable’s value using neovim’s headless mode or vim’s ex mode using the default vimrc available in scope

Notes

• Will leverage search::find_vimrc to load in the appropriate vimrc during ex mode
• If allow_zero is true, then a value of 0 is considered the value of the variable rather than vim’s default of not being found

pub fn load_typed_with_config<P: AsRef<Path>, T>( &self, config: P, allow_zero: bool, ) -> Result<Option<T>>

where T: DeserializeOwned,

Loads variable with Self::load_with_config and then attempts to convert it to the specified type

Notes

• If allow_zero is true, then a value of 0 is considered the value of the variable rather than vim’s default of not being found

pub fn load_with_config<P: AsRef<Path>>( &self, config: P, allow_zero: bool, ) -> Result<Option<Value>>

Loads the variable’s value using neovim’s headless mode or vim’s ex mode

Notes

• Spawns a vim process whose goal is to print out the contents of a variable as a JSON string
• Leverages batch & ex modes with redir to execute and capture output
• Relies on the variable being available upon loading vim configs
• If allow_zero is true, then a value of 0 is considered the value of the variable rather than vim’s default of not being found

Trait Implementations

impl<Name: Clone + AsRef<str>> Clone for VimVar<Name>

fn clone(&self) -> VimVar<Name>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Name: Debug + AsRef<str>> Debug for VimVar<Name>

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

Formats the value using the given formatter.

impl<Name: PartialEq + AsRef<str>> PartialEq for VimVar<Name>

fn eq(&self, other: &VimVar<Name>) -> 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<Name: Eq + AsRef<str>> Eq for VimVar<Name>

impl<Name: AsRef<str>> StructuralPartialEq for VimVar<Name>