ForesterHttpApi

Struct ForesterHttpApi 

Source
pub struct ForesterHttpApi {
    pub base: String,
}
Expand description

The api to Forester instance of http server It is used to get access to the blackboard and to trace events.

#Example

use forester_http::api::ForesterHttpApi;

async fn main() {
    let api = ForesterHttpApi::new("http://localhost:10000".to_string());
    let  _ = reqwest::get(api.print_trace()).await;
}

Fields§

§base: String

The base url of the Forester instance. Typically it is http://localhost:10000

Implementations§

Source§

impl ForesterHttpApi

Source

pub fn trace_event(&self) -> String

creates a new trace event

Source

pub fn print_trace(&self) -> String

prints the trace or if the file is big the tail of the trace (last 100 lines)

Source

pub fn lock(&self, key: String) -> String

lock the key in the blackboard

Source

pub fn unlock(&self, key: String) -> String

unlock the key in the blackboard

Source

pub fn locked(&self, key: String) -> String

check if the key is locked in the blackboard

Source

pub fn contains(&self, key: String) -> String

check if the key is in the blackboard

Source

pub fn take(&self, key: String) -> String

take the key from the blackboard.

Source

pub fn get(&self, key: String) -> String

get the key from the blackboard.

Source

pub fn put(&self, key: String) -> String

put the key to the blackboard.

Source

pub fn new(base: String) -> Self

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