Enum NotebookFocus 

#[non_exhaustive]
pub enum NotebookFocus {
    None,
    Collapsed(FocusPosition),
    Selection {
        anchor: FocusPosition,
        focus: FocusPosition,
    },
}

Specifies the user’s focus and optional selection within the notebook.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

The user has no focus within the notebook.

Collapsed(FocusPosition)

The user focus is within the notebook and the focus is on a single position. I.e. there is no selection.

Selection

The user has a selection within the notebook that started at the given anchor position and ends at the given focus position.

Fields

anchor: FocusPosition

focus: FocusPosition

Implementations

impl NotebookFocus

pub fn anchor_cell_id(&self) -> Option<&str>

pub fn anchor_cell_index(&self, cell_ids: &[&str]) -> Option<usize>

pub fn anchor_field(&self) -> Option<&str>

pub fn anchor_offset(&self) -> u32

pub fn anchor_position(&self) -> Option<&FocusPosition>

pub fn end_cell_id(&self, cell_ids: &[&str]) -> Option<&str>

pub fn end_offset(&self, cell_ids: &[&str]) -> u32

pub fn focus_cell_id(&self) -> Option<&str>

pub fn focus_cell_index(&self, cell_ids: &[&str]) -> Option<usize>

pub fn focus_field(&self) -> Option<&str>

pub fn focus_offset(&self) -> u32

pub fn focus_position(&self) -> Option<&FocusPosition>

pub fn has_selection(&self) -> bool

pub fn is_collapsed(&self) -> bool

Returns whether the cursor position is collapsed, ie. the opposite of has_selection().

pub fn is_none(&self) -> bool

pub fn start_cell_id(&self, cell_ids: &[&str]) -> Option<&str>

pub fn start_offset(&self, cell_ids: &[&str]) -> u32

Trait Implementations

impl Clone for NotebookFocus

fn clone(&self) -> NotebookFocus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookFocus

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

Formats the value using the given formatter.

impl Default for NotebookFocus

fn default() -> NotebookFocus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NotebookFocus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NotebookFocus

impl PartialEq for NotebookFocus

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NotebookFocus

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 NotebookFocus