Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub auto_reload: bool,
    pub debounce_ms: u32,
    pub image_viewer: Option<String>,
    pub plot_viewer: Option<String>,
    pub show_timings: bool,
    pub clear_on_run: bool,
}
Expand description

Configuration options for a cellbook.

Pass to the cellbook!() macro to customize behavior:

// Using struct literal
cellbook!(Config {
    auto_reload: false,
    ..Default::default()
});

// Using builder methods
cellbook!(Config::default()
    .auto_reload(false)
    .image_viewer("feh"));

// Using defaults
cellbook!();

Fields§

§auto_reload: bool

Watch for file changes and rebuild automatically. Default: true

§debounce_ms: u32

Debounce delay for file watcher in milliseconds. Default: 500

§image_viewer: Option<String>

External command to view images (e.g., “feh”, “open”, “xdg-open”). If None, uses platform default.

§plot_viewer: Option<String>

External command to view plots. If None, uses image_viewer or platform default.

§show_timings: bool

Show timing information for cell execution. Default: false

§clear_on_run: bool

Clear output between cell runs. Default: false

Implementations§

Source§

impl Config

Source

pub fn auto_reload(self, enabled: bool) -> Self

Enable or disable auto-reload on file changes.

Source

pub fn debounce_ms(self, ms: u32) -> Self

Set the debounce delay for file watching.

Source

pub fn image_viewer(self, cmd: impl Into<String>) -> Self

Set the external image viewer command.

Source

pub fn plot_viewer(self, cmd: impl Into<String>) -> Self

Set the external plot viewer command.

Source

pub fn show_timings(self, enabled: bool) -> Self

Enable or disable timing display for cell execution.

Source

pub fn clear_on_run(self, enabled: bool) -> Self

Enable or disable clearing output between runs.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.