Skip to main content

RpcBackend

Struct RpcBackend 

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

RPC backend for distributed inference across multiple machines

Implementations§

Source§

impl RpcBackend

Source

pub fn init(endpoint: &str, device: u32) -> Result<Self, RpcError>

Initialize a new RPC backend for the given endpoint and remote device.

§Arguments
  • endpoint - The RPC server endpoint (e.g., “127.0.0.1:50052”)
  • device - Index of the device to use on the remote server. A single endpoint can expose several devices; pass 0 for the first.
§Errors

Returns RpcError::StringConversion if endpoint contains an interior NUL, or RpcError::InitializationFailed if llama.cpp could not reach the endpoint or the device index is out of range.

§Example
use llama_cpp_4::rpc::RpcBackend;

let backend = RpcBackend::init("127.0.0.1:50052", 0)?;
Source

pub fn is_rpc(&self) -> bool

Check if a backend is an RPC backend

Source

pub fn buffer_type(&self) -> Option<NonNull<ggml_backend_buffer_type>>

Get the buffer type for this RPC backend

Source

pub fn get_device_memory(&self) -> Result<(usize, usize), RpcError>

Query the available memory on the remote device

Returns (free_memory, total_memory) in bytes.

§Errors

Returns RpcError::MemoryQueryFailed when the server reports a total of zero, which is how an unreachable endpoint surfaces here.

Source

pub fn endpoint(&self) -> &str

Get the endpoint this backend is connected to

Source

pub fn device(&self) -> u32

Index of the remote device this backend is bound to.

Source

pub fn as_ptr(&self) -> NonNull<ggml_backend>

Get the raw backend pointer for FFI calls.

The pointer is owned by this RpcBackend and is freed on drop; do not free it, and do not use it after this value goes out of scope.

Trait Implementations§

Source§

impl Debug for RpcBackend

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for RpcBackend

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for RpcBackend

Source§

impl Sync for RpcBackend

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<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