Struct FootnoteView 

pub struct FootnoteView {
    pub label: String,
    pub text: Option<String>,
    pub offset: Option<u32>,
    pub end: Option<u32>,
}

A footnote reference and the note it names — what LeafDoc::footnote_at answers with. The FFI mirror of leaf_core::FootnoteRef.

A reference whose definition the document is missing still comes back, with its label and no text: that a [^99] names nothing is a thing to tell the reader, and it is not the same as the caret standing on no reference at all (which is None).

Fields

label: String

The reference’s label — the 1 of [^1], without the ^ or brackets.

text: Option<String>

The note’s body as source text, or None when nothing defines it.

offset: Option<u32>

The byte offset the note’s body starts at, for a “go to note” that moves the caret there. None alongside a None text.

end: Option<u32>

Where the body ends, exclusive. With offset this bounds the note, so a frontend can map the pair through pos_for_offset to the rendered rows it occupies and draw those — the note with its markup resolved, rather than the asterisks and backticks text carries. None alongside a None offset.

Trait Implementations

impl<UT> ConvertError<UT> for FootnoteView

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

impl<UT> FfiConverter<UT> for FootnoteView

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 From<FootnoteRef> for FootnoteView

fn from(f: FootnoteRef) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for FootnoteView

type FfiType = <FootnoteView 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 FootnoteView

type LiftType = FootnoteView

impl<UT> LiftReturn<UT> for FootnoteView

type ReturnType = <FootnoteView 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 FootnoteView

type FfiType = <FootnoteView 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 FootnoteView

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for FootnoteView

type ReturnType = <FootnoteView 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 FootnoteView

const TYPE_ID_META: MetadataBuffer