ScreepsApi

Struct ScreepsApi 

Source
pub struct ScreepsApi {
    pub http_client: ScreepsHttpClient,
}
Expand description

Screeps Api

Fields§

§http_client: ScreepsHttpClient

http 客户端

Implementations§

Source§

impl ScreepsApi

Source

pub fn new(config: ScreepsConfig) -> Self

Source

pub async fn auth(&self) -> ScreepsResult<TokenData>

登录获取 token 数据

Source

pub async fn request<T: Serialize, U: DeserializeOwned>( &self, method: Method, path: &str, body: Option<T>, ) -> ScreepsResult<U>

请求接口

Source

pub async fn get_my_info(&self) -> ScreepsResult<MyInfoData>

获取自己的信息数据

Source

pub async fn get_my_name(&self) -> ScreepsResult<MyNameData>

获取我的名字

Source

pub async fn get_user_rooms(&self, id: &str) -> ScreepsResult<UserAllRoomsData>

获取玩家的所有房间

Source

pub async fn get_user_info_by_name( &self, username: &str, ) -> ScreepsResult<UserInfoData>

根据用户名获取玩家信息

Source

pub async fn get_user_info_by_id(&self, id: &str) -> ScreepsResult<UserInfoData>

根据用户ID获取玩家信息

Source

pub async fn get_room_objects( &self, room: &str, shard: &str, ) -> ScreepsResult<RoomObjectsData>

获取房间对象数据 参数:

  • room: 房间名称
  • shard: shard 名称
Source

pub async fn get_room_terrain( &self, room: &str, shard: &str, ) -> ScreepsResult<RoomTerrainData>

获取房间地形数据

Source

pub async fn get_room_terrain_encoded( &self, room: &str, shard: &str, ) -> ScreepsResult<EncodedRoomTerrainData>

获取编码后的房间地形数据

Source

pub async fn get_room_status( &self, room: &str, shard: &str, ) -> ScreepsResult<RoomStatusData>

获取房间状态数据

Source

pub async fn get_shards(&self) -> ScreepsResult<AllShardData>

获取所有shard的信息

Source

pub async fn get_shard_time(&self, shard: &str) -> ScreepsResult<ShardTimeData>

获取指定 shard 的游戏时间

Trait Implementations§

Source§

impl Default for ScreepsApi

Source§

fn default() -> Self

默认实现只能调用无 token 要求的接口

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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<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
Source§

impl<T> ErasedDestructor for T
where T: 'static,