Enum fiberplane_models::notebooks::Cell

#[non_exhaustive]
pub enum Cell {
    Checkbox(CheckboxCell),
    Code(CodeCell),
    Discussion(DiscussionCell),
    Divider(DividerCell),
    Graph(GraphCell),
    Heading(HeadingCell),
    Image(ImageCell),
    ListItem(ListItemCell),
    Log(LogCell),
    Provider(ProviderCell),
    Table(TableCell),
    Timeline(TimelineCell),
    Text(TextCell),
}

Representation of a single notebook cell.

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.

Checkbox(CheckboxCell)

Code(CodeCell)

Discussion(DiscussionCell)

Divider(DividerCell)

Graph(GraphCell)

Heading(HeadingCell)

Image(ImageCell)

ListItem(ListItemCell)

Log(LogCell)

Provider(ProviderCell)

Table(TableCell)

Timeline(TimelineCell)

Text(TextCell)

Implementations

impl Cell

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

Returns the cell’s content, if any.

pub fn formatting(&self) -> Option<&Formatting>

Returns the cell’s formatting, if any.

pub fn supports_formatting(&self) -> bool

pub fn id(&self) -> &str

Returns the cell’s ID.

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

Returns the cell’s text, if any.

pub fn with_id(&self, id: &str) -> Self

Returns a copy of the cell with a new ID.

pub fn with_text(&self, text: impl Into<String>) -> Self

Returns a copy of the cell with its text replaced by the given text, without any formatting.

pub fn with_rich_text( &self, text: impl Into<String>, formatting: Formatting ) -> Self

Returns a copy of the cell with its text replaced by the given text and formatting.

Warning: For cell types that have text, but which do not support rich-text, the formatting will be dropped silently.

pub fn with_text_for_field<T>( &self, text: T, formatting: Option<Formatting>, field: Option<impl AsRef<str>> ) -> Self

where T: Into<String> + AsRef<str>,

Returns a copy of the cell with the text for the given field replaced by the given text and optional formatting.

If no field is given, the text is applied to the cell’s main text field, similar to with_text() or with_rich_text(), depending on whether any formatting is given.

Warning: For cell types that have text, but which do not support rich-text, any given formatting will be dropped silently.

pub fn id_mut(&mut self) -> &mut String

pub fn formatting_mut(&mut self) -> Option<&mut Formatting>

Returns a mutable reference to the formatting array if the cell type supports formatting.

pub fn text_mut(&mut self) -> Option<&mut String>

Returns a mutable reference to the cell’s text, if any.

pub fn type_str(&self) -> &str

Returns the cell type as a string

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cell

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cell

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

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 Cell