Skip to main content

CodeView

Struct CodeView 

Source
pub struct CodeView<'a> { /* private fields */ }
Expand description

A read-only, virtualized code view. See the module docs.

Implementations§

Source§

impl<'a> CodeView<'a>

Source

pub fn new(id: &'a str, text: &'a str) -> Self

Source

pub fn lang(self, lang: Option<&'a str>) -> Self

The language (a name, alias or extension; see ashlar_syntax::Lang::from_name). Unknown or None shows plain text.

Source

pub fn lang_for_path(self, path: &str) -> Self

The language for a file path ("src/main.rs").

Source

pub fn revision(self, revision: u64) -> Self

Bump when the text changes. (A change of the text’s address or length is noticed anyway; an edit that keeps both needs a new revision.)

Source

pub fn wrap(self, wrap: bool) -> Self

Wrap long lines at the view’s width (off: long lines are clipped).

Source

pub fn line_numbers(self, yes: bool) -> Self

Show the line-number gutter (on by default).

Source

pub fn theme(self, theme: &'a SyntaxTheme) -> Self

Token colours (default: SyntaxTheme::from_tokens of the current tokens).

Source

pub fn highlighter(self, h: &'a dyn Highlighter) -> Self

The highlighting engine (default: Builtin).

Source

pub fn marks(self, marks: &'a [Range<usize>]) -> Self

Byte ranges to mark (search hits), sorted by start and not overlapping.

Source

pub fn scroll_to_line(self, line: Option<usize>) -> Self

Scroll so this line (0-based) is visible.

Source

pub fn max_height(self, h: f32) -> Self

Cap the view’s height (default: the available height).

Source

pub fn show(self, ui: &mut Ui) -> CodeViewResponse

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for CodeView<'a>

§

impl<'a> !Send for CodeView<'a>

§

impl<'a> !Sync for CodeView<'a>

§

impl<'a> !UnwindSafe for CodeView<'a>

§

impl<'a> Forget for CodeView<'a>

§

impl<'a> Freeze for CodeView<'a>

§

impl<'a> Move for CodeView<'a>

§

impl<'a> Unpin for CodeView<'a>

§

impl<'a> UnsafeUnpin for CodeView<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> 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
Source§

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

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.