Struct NotebookIndex 

pub struct NotebookIndex { /* private fields */ }

Jupyter Notebook indexing table

When we lint a jupyter notebook, we have to translate the row/column based on ruff_text_size::TextSize to jupyter notebook cell/row/column.

Implementations

impl NotebookIndex

pub fn cell(&self, row: OneIndexed) -> Option<OneIndexed>

Returns the (raw) cell number (1-based) for the given row (1-based).

pub fn cell_row(&self, row: OneIndexed) -> Option<OneIndexed>

Returns the row number (1-based) in the cell (1-based) for the given row (1-based).

pub fn iter(&self) -> impl Iterator<Item = CellStart> + '_

Returns an iterator over the starting rows of each cell (1-based).

This yields one entry per Python cell (skipping over Markdown cell).

pub fn translate_line_column(&self, source_location: &LineColumn) -> LineColumn

Translates the given LineColumn based on the indexing table.

This will translate the row/column in the concatenated source code to the row/column in the Jupyter Notebook cell.

pub fn translate_source_location( &self, source_location: &SourceLocation, ) -> SourceLocation

Translates the given SourceLocation based on the indexing table.

This will translate the line/character in the concatenated source code to the line/character in the Jupyter Notebook cell.

Trait Implementations

impl Clone for NotebookIndex

fn clone(&self) -> NotebookIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NotebookIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NotebookIndex

impl PartialEq for NotebookIndex

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NotebookIndex

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 NotebookIndex