Struct codesort::Loc

#[non_exhaustive]
pub struct Loc {
    pub content: String,
    pub sort_key: String,
    pub indent: usize,
    pub start_depth: usize,
    pub end_depth: usize,
    pub is_annotation: bool,
    pub can_complete: bool,
    pub wishes: Vec<Wish>,
    pub gifts: Vec<Gift>,
}

A Line of Code, analyzed.

While public, this is implementation dependant and may change on patch versions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: String

The whole content of the line, including the ending newline

sort_key: String

The key used for sorting, may be empty

indent: usize

number of bytes of leading spaces

start_depth: usize

The syntactic depth considered on the whole file, at start of line

end_depth: usize

The syntactic depth considered on the whole file, at end of line

is_annotation: bool

Whether this line starts a java annotation, a rust attribute, etc.

can_complete: bool

wishes: Vec<Wish>

wishes needed after this loc

gifts: Vec<Gift>

gifts not required by this loc

Implementations

impl Loc

pub fn min_depth(&self) -> usize

Either the depth at start, or the depth at end, whichever is smaller

pub fn starts_with(&self, s: &str) -> bool

Whether the deindented content starts with the given string

pub fn last_significant_char(&self) -> Option<char>

the last character which is not a whitespace or part of a comment

pub fn is_sortable(&self) -> bool

Trait Implementations

impl Clone for Loc

fn clone(&self) -> Loc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Loc

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

Formats the value using the given formatter.

impl Display for Loc

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

Formats the value using the given formatter.

impl Ord for Loc

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Loc

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Loc

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Eq for Loc