pub struct DocFs { /* private fields */ }Expand description
Helper for serving service documentation through VFS paths.
Services delegate ["doc", ...] walk/read/readdir operations to this helper.
Documentation is generated at compile time by the proc macro from Cap’n Proto
schema annotations ($mcpDescription, $paramDescription, $docExample).
Implementations§
Source§impl DocFs
impl DocFs
Sourcepub fn new(
render: fn(&[&str]) -> Option<String>,
metadata: fn() -> (&'static str, &'static [MethodMeta]),
) -> Self
pub fn new( render: fn(&[&str]) -> Option<String>, metadata: fn() -> (&'static str, &'static [MethodMeta]), ) -> Self
Create a new DocFs from generated functions.
Sourcepub fn list_entries(&self, path: &[&str]) -> Vec<String>
pub fn list_entries(&self, path: &[&str]) -> Vec<String>
List available documentation entries at a path.
At the root, lists all non-hidden methods from schema_metadata().
Auto Trait Implementations§
impl Freeze for DocFs
impl RefUnwindSafe for DocFs
impl Send for DocFs
impl Sync for DocFs
impl Unpin for DocFs
impl UnsafeUnpin for DocFs
impl UnwindSafe for DocFs
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> ServiceExt for T
impl<T> ServiceExt for T
§fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
Apply a transformation to the response body. Read more
§fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
High level tracing that classifies responses using HTTP status codes. Read more
§fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
High level tracing that classifies responses using gRPC headers. Read more