Skip to main content

EdgeLlm

Struct EdgeLlm 

Source
pub struct EdgeLlm { /* private fields */ }
Expand description

The flat FFI-friendly facade (ADR-001, ADR-009, ADR-010).

Annotated for all three binding surfaces:

  • uniffi::Object (native) → opaque UniFFI / React Native handle
  • frb(opaque) (native) → opaque Dart handle via FRB v2 codegen
  • wasm_bindgen (wasm32) → satisfies IntoWasmAbi/WasmDescribe so that #[wasm_bindgen] impl EdgeLlm { ... } compiles

Implementations§

Source§

impl EdgeLlm

UniFFI-exported methods: constructors, blocking chat, and reset.

Dart uses the edge_llm_* free-function wrappers below so FRB does not need to parse the UniFFI-decorated impl block after macro expansion.

Source

pub fn local(model_uri: String) -> Result<Self, SdkError>

Construct with the local Candle engine (air-gapped, ADR-002/004).

If model_uri is non-empty, loads the GGUF at that path via CandleEngine::from_path (consumer-supplied model, ADR-002). Pass an empty string to use a deterministic toy model for development and testing — the toy generates gibberish but exercises the full binding layer end-to-end.

Returns Err(SdkError) if model_uri is non-empty but the file cannot be parsed (missing, malformed GGUF, incompatible tensor shapes). An empty model_uri never fails.

The permissive signature verifier used here is intentional: it lets the binding layer be exercised without a signed model artifact. A production deployment should substitute a real SignatureVerifier backed by the platform keystore.

Source

pub fn cloud(model: String, api_key: String) -> Self

Construct with a frontier cloud backend (opt-in, ADR-010).

model uses the routing prefix: "openai/gpt-4o", "anthropic/claude-sonnet-4-6", "ollama/llama3", "gemini/gemini-2.0-flash", or any OpenAI-compat base URL. api_key must come from the platform keystore — never embedded.

Native only (React Native / Dart native). On wasm32 this constructor does not exist — the web surface exposes a throwing cloud instead (see the wasm32 impl block below and the ADR-010 amendment).

Source

pub fn ask(&self, prompt: String) -> Result<String, SdkError>

Blocking chat completion.

Returns Err(SdkError::ProviderError) on network/auth/engine failure so callers can distinguish model output from error conditions.

Source

pub fn reset(&self)

Reset the session (clears KV cache and output).

Source§

impl EdgeLlm

Streaming via callback interface — exported for React Native (UniFFI).

Separated from the main block because UniFFI cannot export impl FnMut.

Source

pub fn ask_stream_cb( &self, prompt: String, handler: Box<dyn StreamHandler>, ) -> Result<(), SdkError>

Stream tokens to a StreamHandler callback (React Native path).

Returns an error on network/auth/engine failure so callers are not left waiting for a stream that will never arrive.

Trait Implementations§

Source§

impl<UT> LiftRef<UT> for EdgeLlm

Source§

impl<UT> LowerError<UT> for EdgeLlm

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for EdgeLlm

Source§

type ReturnType = <Arc<EdgeLlm> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more
Source§

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

Lower the return value from an scaffolding call Read more
Source§

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

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for EdgeLlm

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> DartSafe for T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> TaskRetFutTrait for T
where T: Send,

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more