Skip to main content

ServedRef

Struct ServedRef 

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

The surfaces a router serves, held for as long as its reader needs them.

A resolution belongs to one generation of the repository and is replaced when the repository moves under the process, so it cannot be lent out as a bare reference tied to the router. This holds the generation alive while the caller reads it, and derefs to the surfaces themselves so that a caller writes router.served()?.summary(url) exactly as it did when the index was immutable.

// the surfaces, read through the generation that resolved them
let served: ServedRef = router.served().expect("a topology that resolves");
assert!(served.topology().surfaces.iter().any(|s| s.id == "home"));

Methods from Deref<Target = Served>§

Source

pub fn topology(&self) -> &Topology

The topology this serves, narrowed and validated.

Source

pub fn shared(&self) -> Arc<Topology> ⓘ

The same topology behind an Arc, for a context that hands it to a capability.

Source

pub fn owner(&self, path: &str) -> Option<(&Surface, &Bound)>

The surface that owns a request path, with what answers it.

Source

pub fn ready(&self, id: &str) -> bool

Is a surface’s producer’s output there? A route the executable answers always is.

Source

pub fn summary(&self, base: &str) -> String

The one line a server logs when it starts: how many surfaces it serves and where each one is, base prefixed so the log is clickable.

Every served surface, not only the public ones: this is an operator’s diagnostic, and the operator attaching a second client needs the MCP mount that the home page has no reason to advertise to a browser.

Both halves are read off the resolution. A surface added tomorrow is in this line, and a route that moves moves here, because nothing below names one.

use majordomus_cli::http::Served;
use majordomus_cli::web::{discover::{self, Runtime}, Topology};
let topology = Topology::new(discover::native_all());
let served = Served::resolve(&topology, std::path::Path::new("/nonexistent"), Runtime::full()).unwrap();
let line = served.summary("http://127.0.0.1:8741");
assert!(line.contains("http://127.0.0.1:8741/swagger"));
// the count is the resolution's, not a number written here: a surface added to
// native_all is in this line, and this assertion does not go stale for saying so
assert!(line.contains(&format!("{} surface(s)", discover::native_all().len())));

Trait Implementations§

Source§

impl Debug for ServedRef

Source§

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

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

impl Deref for ServedRef

Source§

type Target = Served

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Served

Dereferences the value.

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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