Struct fiberplane_models::realtime::FocusPosition

#[non_exhaustive]
pub struct FocusPosition {
    pub cell_id: String,
    pub field: Option<String>,
    pub offset: Option<u32>,
}

A single focus position within a notebook.

Focus can be placed within a cell, and optionally within separate fields within the cell. An offset can be specified to indicate the exact position of the cursor within a text field.

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.

cell_id: String

ID of the focused cell.

May be the ID of an actual cell, or a so-called “surrogate ID”, such as the ID that indicates focus is on the title field.

field: Option<String>

Key to identify which field inside a cell has focus. May be None for cells that have only one (or no) text field. E.g.: For time range cells, “to” or “from” could be used.

Note that fields do not necessarily have to be text fields. For example, we could also use this to indicate the user has focused a button for graph navigation.

offset: Option<u32>

Offset within the text field. May be None if the focus is not inside a text field.

Implementations

impl FocusPosition

pub fn builder() -> FocusPositionBuilder<((), (), ())>

Create a builder for building FocusPosition. On the builder, call .cell_id(...), .field(...), .offset(...) to set the values of the fields. Finally, call .build() to create the instance of FocusPosition.

Trait Implementations

impl Clone for FocusPosition

fn clone(&self) -> FocusPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FocusPosition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FocusPosition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FocusPosition

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FocusPosition

impl StructuralPartialEq for FocusPosition