Skip to main content

Surface

Struct Surface 

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

The registry seen as resources and tools.

The context is taken from Live per call rather than held, because an MCP session outlives many commits: a surface that captured one context would answer a client attached this morning with the repository as it was this morning, for the whole day. The listings are memoised per generation of the repository, so a client that lists its tools a thousand times builds them once, and a client that lists them after a commit that added a capability sees it.

Implementations§

Source§

impl Surface

Source

pub fn new(live: impl IntoLive) -> Self

A surface over a view of the repository.

Source

pub fn for_peer(&self, peer: PeerId) -> Self

The same surface, seen from one peer: every call it makes carries that identity, which is how peers.announce knows who is speaking. The listings are shared.

Source

pub fn tools_json(&self) -> Arc<Vec<Value>> ⓘ

The tool listing as tools/list answers it, prepared once per generation.

Source

pub fn resources_json(&self) -> Arc<Vec<Value>> ⓘ

The resource listing as resources/list answers it, prepared once per generation.

Source

pub fn tools_result(&self) -> Arc<Box<RawValue>> ⓘ

The whole tools/list result, {"tools": [...]}, serialised once: a frame that carries it copies bytes and builds nothing.

Source

pub fn resources_result(&self) -> Arc<Box<RawValue>> ⓘ

The whole resources/list result, {"resources": [...]}, serialised once.

Source

pub fn context(&self) -> Arc<Context> ⓘ

The context behind the surface, as the repository is now.

Owned rather than borrowed: the context this answers with is replaced when the repository moves, so a reference into the surface would be a promise it cannot keep. Callers hold the Arc for as long as they read it, which is what keeps one answer built from one generation.

let surface = Surface::new(ctx);
// the peer board is this process's own life and is the same across every reading
assert!(Arc::ptr_eq(&surface.context().peers, &surface.context().peers));
Source

pub fn peer(&self) -> Option<&PeerId>

The peer this surface speaks for, when it speaks for one.

Source

pub fn index(&self) -> Arc<Index> ⓘ

The index behind the surface, as the repository is now.

let surface = Surface::new(ctx);
assert_eq!(surface.index().objects.len(), surface.context().index.objects.len());
Source

pub fn registry(&self) -> Arc<CapabilityRegistry> ⓘ

The registry behind the surface, as the repository is now.

let surface = Surface::new(ctx);
assert_eq!(surface.registry().len(), surface.context().registry.len());
Source

pub fn resources(&self) -> Arc<Vec<Resource>> ⓘ

Every resource: executable ones (a query read as a document) first, then the declarative ones, each group by canonical id. Computed once and shared.

Source

pub fn read(&self, uri: &str) -> Result<ResourceContent, SurfaceError>

Read one resource: an object’s content, or a query with a resource exposure answered as JSON. The resolution is objects.get’s (builtin::resolve), so the tool, the HTTP route and this read answer one URI alike.

Source

pub fn tools(&self) -> Arc<Vec<Tool>> ⓘ

Every tool, by canonical id. Computed once and shared.

Source

pub fn call( &self, name: &str, args: &Value, ) -> Result<ToolOutcome, SurfaceError>

Call a tool by name, for a caller on this machine.

Source

pub fn repository_info(&self) -> Result<Value, SurfaceError>

The repository report, as the repository.info capability answers it.

Trait Implementations§

Source§

impl Clone for Surface

Source§

fn clone(&self) -> Surface

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Surface

Source§

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

Formats the value using the given formatter. Read more

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
§

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

§

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

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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