Struct FootnoteDefView 

pub struct FootnoteDefView {
    pub label: String,
    pub offset: Option<u32>,
}

A footnote definition and the reference that sends a reader to it — what LeafDoc::footnote_definition_at_caret answers with, and the FFI mirror of leaf_core::FootnoteDef.

The other half of FootnoteView’s round trip: that one carries a reader down to the note, this one carries them back up. A definition nothing cites still comes back, with its label and no offset, for the reason an undefined reference does — “nothing refers to this note” is worth saying.

Fields

label: String

The definition’s label — the 1 of [^1]: …, spelled exactly as FootnoteView::label spells the same footnote’s.

offset: Option<u32>

The byte offset the first reference starts at, for a “back to reference” that moves the caret there. None for a note nothing refers to.

Trait Implementations

impl<UT> ConvertError<UT> for FootnoteDefView

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

impl<UT> FfiConverter<UT> for FootnoteDefView

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<FootnoteDef> for FootnoteDefView

fn from(f: FootnoteDef) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for FootnoteDefView

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

type LiftType = FootnoteDefView

impl<UT> LiftReturn<UT> for FootnoteDefView

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for FootnoteDefView

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

const TYPE_ID_META: MetadataBuffer