Struct Highlight 

pub struct Highlight {
    pub start: u64,
    pub end: u64,
    pub id: String,
    pub color: Option<String>,
    pub marker: Option<String>,
}

A host-painted range of the source — an annotation’s footprint, a search hit. The FFI shape of leaf_core::Highlight; see LeafDoc::set_highlights.

Fields

start: u64

Byte offset in the source where the wash begins.

end: u64

Byte offset where it ends (exclusive).

id: String

The host’s name for it, handed back on activation. Opaque to leaf.

color: Option<String>

A rendering hint (#RRGGBB), or None for the theme’s default wash.

marker: Option<String>

A margin glyph’s name (an SF Symbol, for this binding’s frontends), or None for wash-only ink. The marker — not the wash — is what activates a highlight; see leaf_core::Highlight::marker.

Trait Implementations

impl<UT> ConvertError<UT> for Highlight

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl<UT> FfiConverter<UT> for Highlight

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for Highlight

type FfiType = <Highlight as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for Highlight

type LiftType = Highlight

impl<UT> LiftReturn<UT> for Highlight

type ReturnType = <Highlight as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for Highlight

type FfiType = <Highlight as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for Highlight

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Highlight

type ReturnType = <Highlight as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for Highlight

const TYPE_ID_META: MetadataBuffer