Struct clang::completion::CompletionString

pub struct CompletionString<'r> { /* fields omitted */ }

A semantic string that describes a code completion result.

Methods

impl<'r> CompletionString<'r>

pub fn get_priority(&self) -> usize

Returns an integer that represents how likely a user is to select this completion string as determined by internal heuristics. Smaller values indicate higher priorities.

pub fn get_annotations(&self) -> Vec<String>

Returns the annotations associated with this completion string.

pub fn get_availability(&self) -> Availability

Returns the availability of this completion string.

pub fn get_comment_brief(&self) -> Option<String>

Returns the documentation comment brief associated with the declaration this completion string refers to, if applicable.

pub fn get_parent_name(&self) -> Option<String>

Returns the name of the semantic parent of the declaration this completion string refers to, if applicable.

pub fn get_typed_text(&self) -> Option<String>

Returns the text of the typed text chunk for this completion string, if any.

pub fn get_chunks(&self) -> Vec<CompletionChunk>

Returns the chunks of this completion string.

Trait Implementations

impl<'r> PartialEq<CompletionString<'r>> for CompletionString<'r>

fn eq(&self, other: &CompletionString<'r>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'r> Clone for CompletionString<'r>

fn clone(&self) -> CompletionString<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r> PartialOrd<CompletionString<'r>> for CompletionString<'r>

fn partial_cmp(&self, other: &CompletionString<'r>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'r> Eq for CompletionString<'r>

impl<'r> Ord for CompletionString<'r>

fn cmp(&self, other: &CompletionString<'r>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'r> Copy for CompletionString<'r>

impl<'r> Debug for CompletionString<'r>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.