Skip to main content

CratesDocsServer

Struct CratesDocsServer 

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

Crates Docs MCP 服务器

主服务器结构体,管理配置、工具注册表和缓存。 支持多种传输协议:stdio、HTTP、SSE、Hybrid。

§字段

  • config: 应用配置
  • tool_registry: 工具注册表
  • cache: 缓存实例

Implementations§

Source§

impl CratesDocsServer

Source

pub fn new(config: AppConfig) -> Result<Self>

创建新的服务器实例(同步)

§参数
  • config - 应用配置
§错误

如果缓存创建失败,返回错误

§注意

此方法仅支持内存缓存。如需使用 Redis,请使用 new_async 方法。

§示例
use crates_docs::{AppConfig, CratesDocsServer};

let config = AppConfig::default();
let server = CratesDocsServer::new(config).expect("Failed to create server");
Source

pub async fn new_async(config: AppConfig) -> Result<Self>

创建新的服务器实例(异步)

§参数
  • config - 应用配置
§错误

如果缓存创建失败,返回错误

§注意

支持内存缓存和 Redis 缓存(需要启用 cache-redis feature)。

§示例
use crates_docs::{AppConfig, CratesDocsServer};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = AppConfig::default();
    let server = CratesDocsServer::new_async(config).await?;
    Ok(())
}
Source

pub fn config(&self) -> &AppConfig

获取服务器配置

Source

pub fn tool_registry(&self) -> &Arc<ToolRegistry>

获取工具注册表

Source

pub fn cache(&self) -> &Arc<dyn Cache>

获取缓存实例

Source

pub fn server_info(&self) -> InitializeResult

获取服务器信息

返回 MCP 初始化结果,包含服务器元数据和能力信息

Source

pub async fn run_stdio(&self) -> Result<()>

运行 Stdio 服务器

§错误

如果服务器启动失败,返回错误

Source

pub async fn run_http(&self) -> Result<()>

运行 HTTP 服务器

§错误

如果服务器启动失败,返回错误

Source

pub async fn run_sse(&self) -> Result<()>

运行 SSE 服务器

§错误

如果服务器启动失败,返回错误

Trait Implementations§

Source§

impl Clone for CratesDocsServer

Source§

fn clone(&self) -> CratesDocsServer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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