Skip to main content

EditorConfig

Struct EditorConfig 

Source
pub struct EditorConfig {
Show 13 fields pub line_numbers: bool, pub line_height: Pixels, pub font_size: Pixels, pub tab_size: usize, pub highlight_active_line: bool, pub block_cursor: bool, pub cursor_blink: bool, pub context_menu: bool, pub show_default_menu_items: bool, pub line_wrap: bool, pub font_family: Option<SharedString>, pub code_font_family: Option<SharedString>, pub markdown: MarkdownConfig,
}
Expand description

Layout and visual settings for the editor canvas.

Fields§

§line_numbers: bool

Whether to render line numbers in the left gutter.

§line_height: Pixels

Vertical line height in pixels.

§font_size: Pixels

Text font size in pixels.

§tab_size: usize

Number of spaces per tab indentation.

§highlight_active_line: bool

Whether to highlight the background of the active cursor line.

§block_cursor: bool

Default cursor shape: true for block, false for line/bar.

§cursor_blink: bool

Whether the cursor should blink when focused.

§context_menu: bool

Whether right-click opens the expandable context menu.

§show_default_menu_items: bool

Whether the built-in edit rows (Undo/Redo/Cut/Copy/Paste/Delete/Select All) lead the context menu. Hooks always append after them.

§line_wrap: bool

Whether to soft-wrap lines at the viewport boundary.

§font_family: Option<SharedString>

Base font family override (None auto-selects, see below).

When unset, the editor probes Self::platform_monospace_candidates at paint time and uses the first family with bold + italic faces. An explicitly set family is trusted verbatim (still probed, so Editor::face_availability stays truthful). Missing faces fall back silently at the OS level, which is why auto-select exists.

§code_font_family: Option<SharedString>

Font family for Code spans (None reuses the base family).

§markdown: MarkdownConfig

Markdown WYSIWYG and syntax configuration.

Implementations§

Source§

impl EditorConfig

Source

pub fn platform_monospace_candidates() -> Vec<SharedString>

Ordered monospace fallback families for font auto-select.

Ordered by likelihood of shipping full (regular/bold/italic/bold-italic) faces: a partial set (e.g. regular+bold only) can never satisfy emphasis, so completeness outranks name recognition.

Source

pub fn font_candidates(&self) -> Vec<SharedString>

Candidate families for auto-select: the explicit family alone when set, otherwise the platform list.

Source

pub fn pick_family( candidates: &[SharedString], probe: impl FnMut(&str) -> (bool, bool), ) -> Option<&SharedString>

Picks the first candidate with bold + italic faces (else the first with either, else None). Pure to stay headless-testable; callers pass a probe comparing resolved FontIds.

Source

pub fn base_font(&self, host: &Font, selected: Option<&SharedString>) -> Font

Resolves the base font: explicit family, else auto-selected family, else host.

Source

pub fn code_font(&self, host: &Font, selected: Option<&SharedString>) -> Font

Resolves the font for Code spans: explicit code family, else whatever Self::base_font resolves (so code follows auto-select by default).

Trait Implementations§

Source§

impl Clone for EditorConfig

Source§

fn clone(&self) -> EditorConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EditorConfig

Source§

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

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

impl Default for EditorConfig

Source§

fn default() -> Self

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

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more