Enum TokenUnderCursor 

pub enum TokenUnderCursor {
    Url(String),
    BinaryFile(String),
    TextFile {
        path: String,
        lnum: Option<i64>,
        col: Option<i64>,
    },
    Directory(String),
    MaybeTextFile {
        value: String,
        lnum: Option<i64>,
        col: Option<i64>,
    },
}

Classified representation of the token found under the cursor.

Used to distinguish between:

• URLs
• existing binary files
• existing text files
• existing directories
• plain tokens (fallback TokenUnderCursor::MaybeTextFile)

Serialized to Lua as a tagged table ({ kind = "...", value = "..." }).

Variants

Url(String)

A string that successfully parsed as a Url via Url::parse.

BinaryFile(String)

A filesystem path identified as a binary file by [ytil_sys::file::exec_file_cmd].

TextFile

A filesystem path identified as a text file by [ytil_sys::file::exec_file_cmd].

Fields

path: String

lnum: Option<i64>

col: Option<i64>

Directory(String)

A filesystem path identified as a directory by [ytil_sys::file::exec_file_cmd].

MaybeTextFile

A fallback plain token (word) when no more specific classification applied.

Fields

value: String

lnum: Option<i64>

col: Option<i64>

Implementations

impl TokenUnderCursor

Classify a String captured under the cursor into a TokenUnderCursor.

1. If it parses as a URL with Url::parse, returns TokenUnderCursor::Url.
2. Otherwise, invokes [ytil_sys::file::exec_file_cmd] to check filesystem type.
3. Falls back to TokenUnderCursor::MaybeTextFile on errors or unknown kinds.

fn classify(value: &str) -> Result<Self>

fn classify_url(value: &str) -> Result<Self>

fn classify_not_url(value: &str) -> Result<Self>

fn refine_word(&self, buffer: &Buffer) -> Result<Self>

Trait Implementations

impl Clone for TokenUnderCursor

fn clone(&self) -> TokenUnderCursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenUnderCursor

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

Formats the value using the given formatter.

impl Pushable for TokenUnderCursor

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 TokenUnderCursor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToObject for TokenUnderCursor

fn to_object(self) -> Result<Object, Error>