Struct SelectionQuote 

pub struct SelectionQuote {
    pub exact: String,
    pub prefix: String,
    pub suffix: String,
    pub start: u64,
    pub end: u64,
}

A selection cited out of the source — the text, a little of what surrounded it, and the byte range it came from. The FFI shape of leaf_core::Quote; see LeafDoc::selection_quote.

Fields

exact: String

The selected source, verbatim.

prefix: String

What immediately preceded it — empty at the document’s start.

suffix: String

What immediately followed it — empty at the document’s end.

start: u64

Byte offset in the source where the selection begins.

end: u64

Byte offset where it ends (exclusive).

Trait Implementations

impl<UT> ConvertError<UT> for SelectionQuote

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

impl<UT> FfiConverter<UT> for SelectionQuote

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 SelectionQuote

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

type LiftType = SelectionQuote

impl<UT> LiftReturn<UT> for SelectionQuote

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SelectionQuote

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

const TYPE_ID_META: MetadataBuffer