Struct FileLines

pub struct FileLines(Option<HashMap<FileName, Vec<Range>>>);

A set of lines in files.

It is represented as a multimap keyed on file names, with values a collection of non-overlapping ranges sorted by their start point. An inner None is interpreted to mean all lines in all files.

Tuple Fields

0: Option<HashMap<FileName, Vec<Range>>>

Implementations

impl FileLines

pub(crate) fn all() -> FileLines

Creates a FileLines that contains all lines in all files.

pub fn is_all(&self) -> bool

Returns true if this FileLines contains all lines in all files.

pub fn from_ranges(ranges: HashMap<FileName, Vec<Range>>) -> FileLines

pub fn files(&self) -> Files<'_>

Returns an iterator over the files contained in self.

pub fn to_json_spans(&self) -> Vec<JsonSpan>

Returns JSON representation as accepted by the --file-lines JSON arg.

fn file_range_matches<F>(&self, file_name: &FileName, f: F) -> bool

where F: FnMut(&Range) -> bool,

Returns true if self includes all lines in all files. Otherwise runs f on all ranges in the designated file (if any) and returns true if f ever does.

pub(crate) fn contains(&self, range: &LineRange) -> bool

Returns true if range is fully contained in self.

pub(crate) fn intersects(&self, range: &LineRange) -> bool

Returns true if any lines in range are in self.

pub(crate) fn contains_line(&self, file_name: &FileName, line: usize) -> bool

Returns true if line from file_name is in self.

pub(crate) fn contains_range( &self, file_name: &FileName, lo: usize, hi: usize, ) -> bool

Returns true if all the lines between lo and hi from file_name are in self.

Trait Implementations

impl Clone for FileLines

fn clone(&self) -> FileLines

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigType for FileLines

fn doc_hint() -> String

Returns hint text for use in Config::print_docs(). For enum types, this is a pipe-separated list of variants; for other types it returns <type>.

fn stable_variant(&self) -> bool

Return true if the variant (i.e. value of this type) is stable.

impl Debug for FileLines

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

Formats the value using the given formatter.

impl Default for FileLines

fn default() -> FileLines

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileLines

fn deserialize<D>(_: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FileLines

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

Formats the value using the given formatter.

impl FromStr for FileLines

type Err = FileLinesError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FileLines, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for FileLines

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

fn serialize<S>(&self, _: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileLines

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes