Struct artemis::client::Client

#[repr(transparent)]pub struct Client<M: Exchange = TerminatorExchange>(pub Arc<ClientImpl<M>>);

An Artemis client type used to run queries against

Implementations

impl Client

pub fn builder<U: Into<String>>(url: U) -> ClientBuilder

Returns a ClientBuilder with the given endpoint URL

impl<M: Exchange> Client<M>

pub async fn query<Q: GraphQLQuery>(
    &self,
    _query: Q,
    variables: Q::Variables
) -> Result<Response<Q::ResponseData>, QueryError>

Executes a query with the given variables Returns the result of the query, or a QueryError if one of the exchanges encountered a fatal error.

Example

let client = ClientBuilder::new("http://localhost:8080/graphql")
    .with_default_exchanges()
    .build();

let result = client.query(GetConference, Variables { id: "1".to_string() }).await.unwrap();

assert!(result.data.is_some())

pub async fn query_with_options<Q: GraphQLQuery>(
    &self,
    _query: Q,
    variables: Q::Variables,
    options: QueryOptions
) -> Result<Response<Q::ResponseData>, QueryError>

Executes a query with the given variables and options Returns the result of the query, or a QueryError if one of the exchanges encountered a fatal error.

Example

let client = ClientBuilder::new("http://localhost:8080/graphql")
    .with_default_exchanges()
    .build();

let result = client.query(GetConference, Variables { id: "1".to_string() }).await.unwrap();

assert!(result.data.is_some())

pub fn subscribe<Q: GraphQLQuery + 'static>(
    &self,
    query: Q,
    variables: Q::Variables
) -> Observable<Result<Response<<Q as GraphQLQuery>::ResponseData>, QueryError>, M>

Subscribes to a query, returning any potential early results, the initial result and any future updates The function returns an Observable which can be subscribed to like a regular stream. Dropping the Observable will cancel the subscription.

Requires feature: observable

Example

let client = ClientBuilder::new("http://localhost:8080/graphql")
    .with_default_exchanges()
    .build();

let mut observable = client.subscribe(GetConference, Variables { id: "1".to_string() });
let result = observable.next().await.unwrap().unwrap();

assert!(result.data.is_some())

pub fn subscribe_with_options<Q: GraphQLQuery + 'static>(
    &self,
    _query: Q,
    variables: Q::Variables,
    options: QueryOptions
) -> Observable<Result<Response<<Q as GraphQLQuery>::ResponseData>, QueryError>, M>

Subscribes to a query with options, returning any potential early results, the initial result and any future updates The function returns an Observable which can be subscribed to like a regular stream. Dropping the Observable will cancel the subscription.

Requires feature: observable

Example

let client = ClientBuilder::new("http://localhost:8080/graphql")
    .with_default_exchanges()
    .build();

let mut observable = client.subscribe(GetConference, Variables { id: "1".to_string() });
let result = observable.next().await.unwrap().unwrap();

assert!(result.data.is_some())

Trait Implementations

impl<M: Clone + Exchange> Clone for Client<M>

fn clone(&self) -> Client<M>

Returns a copy of the value.

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

Performs copy-assignment from source.