Skip to main content

GutterOpts

Struct GutterOpts 

Source
pub struct GutterOpts<G> {
    pub total_lines: usize,
    pub viewport_height: u32,
    pub gutter_fn: G,
}
Expand description

Options for Context::scrollable_with_gutter.

Carries the bookkeeping arguments together so call sites become readable:

// 90% case — automatic line numbers.
ui.scrollable_with_gutter(
    &mut scroll,
    GutterOpts::line_numbers(120, 24),
    |ui, line| { ui.text(format!("line {line}")); },
);

// Custom gutter labels.
ui.scrollable_with_gutter(
    &mut scroll,
    GutterOpts::new(120, 24, |i| if i == 7 { "!".to_string() } else { String::new() }),
    |ui, line| { ui.text(format!("line {line}")); },
);

Fields§

§total_lines: usize

Total number of content lines.

§viewport_height: u32

Viewport height in rows.

§gutter_fn: G

Closure that returns the gutter label for a given absolute line index.

Implementations§

Source§

impl<G> GutterOpts<G>
where G: Fn(usize) -> String,

Source

pub fn new(total_lines: usize, viewport_height: u32, gutter_fn: G) -> Self

Build options with an explicit gutter labeling closure.

Source§

impl GutterOpts<fn(usize) -> String>

Source

pub fn line_numbers(total_lines: usize, viewport_height: u32) -> Self

Shortcut for the 90% case: render 1-based line numbers in the gutter.

Equivalent to GutterOpts::new(total, viewport, |i| format!("{}", i + 1)) but uses a function pointer to avoid forcing the caller to name the closure type.

Auto Trait Implementations§

§

impl<G> Freeze for GutterOpts<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for GutterOpts<G>
where G: RefUnwindSafe,

§

impl<G> Send for GutterOpts<G>
where G: Send,

§

impl<G> Sync for GutterOpts<G>
where G: Sync,

§

impl<G> Unpin for GutterOpts<G>
where G: Unpin,

§

impl<G> UnsafeUnpin for GutterOpts<G>
where G: UnsafeUnpin,

§

impl<G> UnwindSafe for GutterOpts<G>
where G: UnwindSafe,

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> 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, 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.