pub struct Client { /* private fields */ }
Expand description
This is the Minehut client struct, it only stores an authentication token and session ID. All data that require authentication can only be ran using this struct.
Implementations
sourceimpl Client
impl Client
sourcepub fn new(auth_token: String, session_id: String) -> Self
pub fn new(auth_token: String, session_id: String) -> Self
Creates a new instance of Client with provided auth and session ID. You can get both of these using the inspect element on the Minehut dashboard.
Arguments
auth
- Authentication token from Minehut.session_id
- Session ID from Minehut.
Example
use minehut::Client;
let client = Client::new("auth-token", "session-id");
// Now do something with
sourcepub async fn my_server(&self, name: &str) -> Result<OwnedServer, Error>
pub async fn my_server(&self, name: &str) -> Result<OwnedServer, Error>
Retrieves a server that the client user owns by name using the Minehut API.
Arguments
name
- Name of the server.
Example
let client = minehut::Client::new("","");
match client.my_server("weird-name").await {
Err(_) => println!("Cannot fetch server"),
Ok(s) => println!("{s:?}")
}
Error
Returns an error if a server could not be found or if found server is not owned by the client user.
Auto Trait Implementations
impl RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more