Struct Syntax Highlighted Builder &nbsp; Copy item path

impl SyntaxHighlightedBuilder

Easily build syntax-highlighted LayoutJobs.

Try to use one of the append_* or with_* methods that semantically matches what you are trying to highlight. Check the docs of the append_* methods for examples of what they should be used with.

The with_* methods are builder-style, taking self and returning Self. The append_* methods take &mut self and return &mut Self.

Use the with_* methods when building something inline.

pub const QUOTE_CHAR: char = '"'

pub fn new() -> SyntaxHighlightedBuilder

pub fn from(job: impl Into<LayoutJob>) -> SyntaxHighlightedBuilder

Construct Self from an existing LayoutJob.

Some information (the leading_space) will be lost.

pub fn with(self, portion: &dyn SyntaxHighlighting) -> SyntaxHighlightedBuilder

Append anything that implements SyntaxHighlighting.

pub fn append( &mut self, portion: &dyn SyntaxHighlighting, ) -> &mut SyntaxHighlightedBuilder

Append anything that implements SyntaxHighlighting.

impl SyntaxHighlightedBuilder

pub fn with_null(self, portion: &str) -> SyntaxHighlightedBuilder

null

pub fn append_null(&mut self, portion: &str) -> &mut SyntaxHighlightedBuilder

null

pub fn null(portion: &str) -> SyntaxHighlightedBuilder

null

pub fn with_primitive(self, portion: &str) -> SyntaxHighlightedBuilder

Some primitive value, e.g. a number or bool.

pub fn append_primitive( &mut self, portion: &str, ) -> &mut SyntaxHighlightedBuilder

Some primitive value, e.g. a number or bool.

pub fn primitive(portion: &str) -> SyntaxHighlightedBuilder

Some primitive value, e.g. a number or bool.

pub fn with_identifier(self, portion: &str) -> SyntaxHighlightedBuilder

A string identifier.

E.g. a variable name, field name, etc. Won’t be quoted.

pub fn append_identifier( &mut self, portion: &str, ) -> &mut SyntaxHighlightedBuilder

A string identifier.

E.g. a variable name, field name, etc. Won’t be quoted.

pub fn identifier(portion: &str) -> SyntaxHighlightedBuilder

A string identifier.

E.g. a variable name, field name, etc. Won’t be quoted.

pub fn with_string_value(self, portion: &str) -> SyntaxHighlightedBuilder

Some string data. Will be quoted.

pub fn append_string_value( &mut self, portion: &str, ) -> &mut SyntaxHighlightedBuilder

Some string data. Will be quoted.

pub fn string_value(portion: &str) -> SyntaxHighlightedBuilder

Some string data. Will be quoted.

pub fn append_string_value_truncated( &mut self, portion: &str, max_chars: usize, ) -> &mut SyntaxHighlightedBuilder

Like Self::append_string_value, but truncates to max_chars characters and appends … (in syntax style) when truncated.

pub fn with_keyword(self, portion: &str) -> SyntaxHighlightedBuilder

A keyword, e.g. a filter operator, like and or all

pub fn append_keyword(&mut self, portion: &str) -> &mut SyntaxHighlightedBuilder

A keyword, e.g. a filter operator, like and or all

pub fn keyword(portion: &str) -> SyntaxHighlightedBuilder

A keyword, e.g. a filter operator, like and or all

pub fn with_index(self, portion: &str) -> SyntaxHighlightedBuilder

An index number, e.g. an array index.

pub fn append_index(&mut self, portion: &str) -> &mut SyntaxHighlightedBuilder

An index number, e.g. an array index.

pub fn index(portion: &str) -> SyntaxHighlightedBuilder

An index number, e.g. an array index.

pub fn with_syntax(self, portion: &str) -> SyntaxHighlightedBuilder

Some syntax, e.g. brackets, commas, colons, etc.

pub fn append_syntax(&mut self, portion: &str) -> &mut SyntaxHighlightedBuilder

Some syntax, e.g. brackets, commas, colons, etc.

pub fn syntax(portion: &str) -> SyntaxHighlightedBuilder

Some syntax, e.g. brackets, commas, colons, etc.

pub fn with_body(self, portion: &str) -> SyntaxHighlightedBuilder

Body text, subdued (default label color).

pub fn append_body(&mut self, portion: &str) -> &mut SyntaxHighlightedBuilder

Body text, subdued (default label color).

pub fn body(portion: &str) -> SyntaxHighlightedBuilder

Body text, subdued (default label color).

pub fn with_body_default(self, portion: &str) -> SyntaxHighlightedBuilder

Body text with default color (color of inactive buttons).

pub fn append_body_default( &mut self, portion: &str, ) -> &mut SyntaxHighlightedBuilder

Body text with default color (color of inactive buttons).

pub fn body_default(portion: &str) -> SyntaxHighlightedBuilder

Body text with default color (color of inactive buttons).

pub fn with_body_italics(self, portion: &str) -> SyntaxHighlightedBuilder

Body text in italics, e.g. for emphasis.

pub fn append_body_italics( &mut self, portion: &str, ) -> &mut SyntaxHighlightedBuilder

Body text in italics, e.g. for emphasis.

pub fn body_italics(portion: &str) -> SyntaxHighlightedBuilder

Body text in italics, e.g. for emphasis.

pub fn append_with_format( &mut self, text: &str, format: TextFormat, ) -> &mut SyntaxHighlightedBuilder

Append text with a custom format.

pub fn append_with_format_closure<F>( &mut self, text: &str, f: F, ) -> &mut SyntaxHighlightedBuilder
where F: 'static + Fn(&Style) -> TextFormat,

Append text with a custom format closure.

pub fn with_format( self, text: &str, format: TextFormat, ) -> SyntaxHighlightedBuilder

With a custom format.

pub fn with_format_closure<F>( self, text: &str, f: F, ) -> SyntaxHighlightedBuilder
where F: 'static + Fn(&Style) -> TextFormat,

With a custom format closure.

pub fn text(&self) -> &str

Trait Implementations§

impl Debug for SyntaxHighlightedBuilder

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

Formats the value using the given formatter. Read more

impl Default for SyntaxHighlightedBuilder

fn default() -> SyntaxHighlightedBuilder

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

impl<T> From<T> for SyntaxHighlightedBuilder
where T: SyntaxHighlighting,

fn from(portion: T) -> SyntaxHighlightedBuilder

Converts to this type from the input type.

Auto Trait Implementations§

impl Freeze for SyntaxHighlightedBuilder

impl !RefUnwindSafe for SyntaxHighlightedBuilder

impl !Send for SyntaxHighlightedBuilder

impl !Sync for SyntaxHighlightedBuilder

impl Unpin for SyntaxHighlightedBuilder

impl UnsafeUnpin for SyntaxHighlightedBuilder

impl !UnwindSafe for SyntaxHighlightedBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

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

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

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> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

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

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

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

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

impl<T> StrictAs for T

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

fn strict_cast_from(src: Src) -> Dst

Casts the value.

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

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

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.