Struct Request 

pub struct Request {
    pub surface: Surface,
    pub words: Vec<String>,
    pub cursor: usize,
    pub cwd: Option<PathBuf>,
}

What a shell asks.

Fields

surface: Surface

Which spelling the words are in.

words: Vec<String>

The words of the command line, the program’s own name included at index 0.

cursor: usize

The index of the word the cursor is in. A cursor past the last word is a new, empty word.

cwd: Option<PathBuf>

Where the shell is. Used only to make a path candidate relative; never scanned.

Implementations

impl Request

pub fn prefix(&self) -> &str

The text of the word being completed, empty when the cursor opens a new one.

pub fn preceding(&self) -> &[String]

The words before the cursor, the program’s own name excluded.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Request

impl JsonSchema for Request

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Request

fn eq(&self, other: &Request) -> 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 Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Request