pub struct RustDocsService { /* private fields */ }
Implementations§
Source§impl RustDocsService
impl RustDocsService
pub fn new(cache_dir: Option<PathBuf>) -> Result<Self>
Sourcepub fn cache_crate_from_cratesio_tool_attr() -> Tool
pub fn cache_crate_from_cratesio_tool_attr() -> Tool
Generated tool metadata function for cache_crate_from_cratesio
pub fn cache_crate_from_cratesio( &self, Parameters: Parameters<CacheCrateFromCratesIOParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn cache_crate_from_github_tool_attr() -> Tool
pub fn cache_crate_from_github_tool_attr() -> Tool
Generated tool metadata function for cache_crate_from_github
pub fn cache_crate_from_github( &self, Parameters: Parameters<CacheCrateFromGitHubParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn cache_crate_from_local_tool_attr() -> Tool
pub fn cache_crate_from_local_tool_attr() -> Tool
Generated tool metadata function for cache_crate_from_local
pub fn cache_crate_from_local( &self, Parameters: Parameters<CacheCrateFromLocalParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn remove_crate_tool_attr() -> Tool
pub fn remove_crate_tool_attr() -> Tool
Generated tool metadata function for remove_crate
pub fn remove_crate( &self, Parameters: Parameters<RemoveCrateParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn list_cached_crates_tool_attr() -> Tool
pub fn list_cached_crates_tool_attr() -> Tool
Generated tool metadata function for list_cached_crates
pub fn list_cached_crates( &self, Parameters: Parameters<ListCachedCratesParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn list_crate_versions_tool_attr() -> Tool
pub fn list_crate_versions_tool_attr() -> Tool
Generated tool metadata function for list_crate_versions
pub fn list_crate_versions( &self, Parameters: Parameters<ListCrateVersionsParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn get_crates_metadata_tool_attr() -> Tool
pub fn get_crates_metadata_tool_attr() -> Tool
Generated tool metadata function for get_crates_metadata
pub fn get_crates_metadata( &self, Parameters: Parameters<GetCratesMetadataParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn list_crate_items_tool_attr() -> Tool
pub fn list_crate_items_tool_attr() -> Tool
Generated tool metadata function for list_crate_items
pub fn list_crate_items( &self, Parameters: Parameters<ListItemsParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn search_items_tool_attr() -> Tool
pub fn search_items_tool_attr() -> Tool
Generated tool metadata function for search_items
pub fn search_items( &self, Parameters: Parameters<SearchItemsParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn search_items_preview_tool_attr() -> Tool
pub fn search_items_preview_tool_attr() -> Tool
Generated tool metadata function for search_items_preview
pub fn search_items_preview( &self, Parameters: Parameters<SearchItemsPreviewParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn get_item_details_tool_attr() -> Tool
pub fn get_item_details_tool_attr() -> Tool
Generated tool metadata function for get_item_details
pub fn get_item_details( &self, Parameters: Parameters<GetItemDetailsParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn get_item_docs_tool_attr() -> Tool
pub fn get_item_docs_tool_attr() -> Tool
Generated tool metadata function for get_item_docs
pub fn get_item_docs( &self, Parameters: Parameters<GetItemDocsParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn get_item_source_tool_attr() -> Tool
pub fn get_item_source_tool_attr() -> Tool
Generated tool metadata function for get_item_source
pub fn get_item_source( &self, Parameters: Parameters<GetItemSourceParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn get_dependencies_tool_attr() -> Tool
pub fn get_dependencies_tool_attr() -> Tool
Generated tool metadata function for get_dependencies
pub fn get_dependencies( &self, Parameters: Parameters<GetDependenciesParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn structure_tool_attr() -> Tool
pub fn structure_tool_attr() -> Tool
Generated tool metadata function for structure
pub fn structure( &self, Parameters: Parameters<AnalyzeCrateStructureParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Sourcepub fn search_items_fuzzy_tool_attr() -> Tool
pub fn search_items_fuzzy_tool_attr() -> Tool
Generated tool metadata function for search_items_fuzzy
pub fn search_items_fuzzy( &self, Parameters: Parameters<SearchItemsFuzzyParams>, ) -> Pin<Box<dyn Future<Output = String> + Send + '_>>
Source§impl RustDocsService
impl RustDocsService
pub fn cache_dependencies_prompt_attr() -> Prompt
pub fn cache_dependencies( &self, Parameters: Parameters<CacheDependenciesArgs>, _ctx: RequestContext<RoleServer>, ) -> Pin<Box<dyn Future<Output = Result<Vec<PromptMessage>, ErrorData>> + Send + '_>>
Trait Implementations§
Source§impl Clone for RustDocsService
impl Clone for RustDocsService
Source§fn clone(&self) -> RustDocsService
fn clone(&self) -> RustDocsService
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RustDocsService
impl Debug for RustDocsService
Source§impl ServerHandler for RustDocsService
impl ServerHandler for RustDocsService
fn get_info(&self) -> ServerInfo
async fn call_tool( &self, request: CallToolRequestParam, context: RequestContext<RoleServer>, ) -> Result<CallToolResult, ErrorData>
async fn list_tools( &self, _request: Option<PaginatedRequestParam>, _context: RequestContext<RoleServer>, ) -> Result<ListToolsResult, ErrorData>
async fn get_prompt( &self, request: GetPromptRequestParam, context: RequestContext<RoleServer>, ) -> Result<GetPromptResult, ErrorData>
async fn list_prompts( &self, _request: Option<PaginatedRequestParam>, _context: RequestContext<RoleServer>, ) -> Result<ListPromptsResult, ErrorData>
fn ping( &self, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send
fn initialize( &self, request: InitializeRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<InitializeResult, ErrorData>> + Send
fn complete( &self, request: CompleteRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<CompleteResult, ErrorData>> + Send
fn set_level( &self, request: SetLevelRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send
fn list_resources( &self, request: Option<PaginatedRequestParam>, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListResourcesResult, ErrorData>> + Send
fn list_resource_templates( &self, request: Option<PaginatedRequestParam>, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ListResourceTemplatesResult, ErrorData>> + Send
fn read_resource( &self, request: ReadResourceRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<ReadResourceResult, ErrorData>> + Send
fn subscribe( &self, request: SubscribeRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send
fn unsubscribe( &self, request: UnsubscribeRequestParam, context: RequestContext<RoleServer>, ) -> impl Future<Output = Result<(), ErrorData>> + Send
fn on_cancelled( &self, notification: CancelledNotificationParam, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + Send
fn on_progress( &self, notification: ProgressNotificationParam, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + Send
fn on_initialized( &self, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + Send
fn on_roots_list_changed( &self, context: NotificationContext<RoleServer>, ) -> impl Future<Output = ()> + Send
Auto Trait Implementations§
impl Freeze for RustDocsService
impl !RefUnwindSafe for RustDocsService
impl Send for RustDocsService
impl Sync for RustDocsService
impl Unpin for RustDocsService
impl !UnwindSafe for RustDocsService
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
Source§impl<T> Cast for T
impl<T> Cast for T
Source§fn cast<U>(self, interner: <U as HasInterner>::Interner) -> Uwhere
Self: CastTo<U>,
U: HasInterner,
fn cast<U>(self, interner: <U as HasInterner>::Interner) -> Uwhere
Self: CastTo<U>,
U: HasInterner,
U
using CastTo
.Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<R, S> DynService<R> for Swhere
R: ServiceRole,
S: Service<R>,
impl<R, S> DynService<R> for Swhere
R: ServiceRole,
S: Service<R>,
fn handle_request( &self, request: <R as ServiceRole>::PeerReq, context: RequestContext<R>, ) -> Pin<Box<dyn Future<Output = Result<<R as ServiceRole>::Resp, ErrorData>> + Send + '_>>
fn handle_notification( &self, notification: <R as ServiceRole>::PeerNot, context: NotificationContext<R>, ) -> Pin<Box<dyn Future<Output = Result<(), ErrorData>> + Send + '_>>
fn get_info(&self) -> <R as ServiceRole>::Info
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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>
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>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);