Struct coap_client::Client

source · [−]

pub struct Client<E, T: Backend<E>> { /* private fields */ }

Expand description

Async CoAP client, generic over Backend implementations

Implementations

source

impl Client<Error, Tokio>

source

pub async fn connect<H>(host: H, opts: &ClientOptions) -> Result<Self, Error> where
H: TryInto<HostOptions>,
<H as TryInto<HostOptions>>::Error: Debug,

Create a new client with the provided host and client options

source

pub async fn close(self) -> Result<(), Error>

Close the provided client, ending all existing sessions

source

impl<E, T> Client<E, T> where
T: Backend<E>,
E: Debug,

source

pub async fn request(
 &mut self,
 method: Method,
 resource: &str,
 data: Option<&[u8 ]>,
 opts: &RequestOptions
) -> Result<Packet, Error<E>>

Perform a basic CoAP request

source

pub async fn observe(
 &mut self,
 resource: &str,
 opts: &RequestOptions
) -> Result<<T as Backend<E>>::Observe, E>

Observe the provided resource

source

pub async fn unobserve(
&mut self,
o: <T as Backend<E>>::Observe
) -> Result<(), E>

Deregister an observation

source

pub async fn get(
 &mut self,
 resource: &str,
 opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

Perform a Get request from the provided resource

source

pub async fn put(
 &mut self,
 resource: &str,
 data: Option<&[u8 ]>,
 opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

Perform a Put request to the provided resource

source

pub async fn post(
 &mut self,
 resource: &str,
 data: Option<&[u8 ]>,
 opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

Perform a Post request to the provided resource

Trait Implementations

source

impl<E, B: Backend<E> + Send> Send for Client<E, B>

Mark clients as Send if the backend is

Auto Trait Implementations

impl<E, T> RefUnwindSafe for Client<E, T> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<E, T> Sync for Client<E, T> where
E: Sync,
T: Sync,

impl<E, T> Unpin for Client<E, T> where
E: Unpin,
T: Unpin,

impl<E, T> UnwindSafe for Client<E, T> where
E: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct coap_client::Client

Implementations

impl Client<Error, Tokio>

pub async fn connect<H>(host: H, opts: &ClientOptions) -> Result<Self, Error> where
H: TryInto<HostOptions>,
<H as TryInto<HostOptions>>::Error: Debug,

pub async fn close(self) -> Result<(), Error>

impl<E, T> Client<E, T> where
T: Backend<E>,
E: Debug,

pub async fn request(
    &mut self,
    method: Method,
    resource: &str,
    data: Option<&[u8 ]>,
    opts: &RequestOptions
) -> Result<Packet, Error<E>>

pub async fn observe(
    &mut self,
    resource: &str,
    opts: &RequestOptions
) -> Result<<T as Backend<E>>::Observe, E>

pub async fn unobserve(
&mut self,
o: <T as Backend<E>>::Observe
) -> Result<(), E>

pub async fn get(
    &mut self,
    resource: &str,
    opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

pub async fn put(
    &mut self,
    resource: &str,
    data: Option<&[u8 ]>,
    opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

pub async fn post(
    &mut self,
    resource: &str,
    data: Option<&[u8 ]>,
    opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

Trait Implementations

impl<E, B: Backend<E> + Send> Send for Client<E, B>

Auto Trait Implementations

impl<E, T> RefUnwindSafe for Client<E, T> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<E, T> Sync for Client<E, T> where
E: Sync,
T: Sync,

impl<E, T> Unpin for Client<E, T> where
E: Unpin,
T: Unpin,

impl<E, T> UnwindSafe for Client<E, T> where
E: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

Struct coap_client::Client

Implementations

impl Client<Error, Tokio>

pub async fn connect<H>(host: H, opts: &ClientOptions) -> Result<Self, Error> where H: TryInto<HostOptions>, <H as TryInto<HostOptions>>::Error: Debug,

pub async fn close(self) -> Result<(), Error>

impl<E, T> Client<E, T> where T: Backend<E>, E: Debug,

pub async fn request( &mut self, method: Method, resource: &str, data: Option<&[u8]>, opts: &RequestOptions) -> Result<Packet, Error<E>>

pub async fn observe( &mut self, resource: &str, opts: &RequestOptions) -> Result<<T as Backend<E>>::Observe, E>

pub async fn unobserve( &mut self, o: <T as Backend<E>>::Observe) -> Result<(), E>

pub async fn get( &mut self, resource: &str, opts: &RequestOptions) -> Result<Vec<u8>, Error<E>>

pub async fn put( &mut self, resource: &str, data: Option<&[u8]>, opts: &RequestOptions) -> Result<Vec<u8>, Error<E>>

pub async fn post( &mut self, resource: &str, data: Option<&[u8]>, opts: &RequestOptions) -> Result<Vec<u8>, Error<E>>

Trait Implementations

impl<E, B: Backend<E> + Send> Send for Client<E, B>

Auto Trait Implementations

impl<E, T> RefUnwindSafe for Client<E, T> where E: RefUnwindSafe, T: RefUnwindSafe,

impl<E, T> Sync for Client<E, T> where E: Sync, T: Sync,

impl<E, T> Unpin for Client<E, T> where E: Unpin, T: Unpin,

impl<E, T> UnwindSafe for Client<E, T> where E: UnwindSafe, T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

pub async fn connect<H>(host: H, opts: &ClientOptions) -> Result<Self, Error> where
H: TryInto<HostOptions>,
<H as TryInto<HostOptions>>::Error: Debug,

impl<E, T> Client<E, T> where
T: Backend<E>,
E: Debug,

pub async fn request(
&mut self,
method: Method,
resource: &str,
data: Option<&[u8 ]>,
opts: &RequestOptions
) -> Result<Packet, Error<E>>

pub async fn observe(
&mut self,
resource: &str,
opts: &RequestOptions
) -> Result<<T as Backend<E>>::Observe, E>

pub async fn unobserve(
&mut self,
o: <T as Backend<E>>::Observe
) -> Result<(), E>

pub async fn get(
&mut self,
resource: &str,
opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

pub async fn put(
&mut self,
resource: &str,
data: Option<&[u8 ]>,
opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

pub async fn post(
&mut self,
resource: &str,
data: Option<&[u8 ]>,
opts: &RequestOptions
) -> Result<Vec<u8>, Error<E>>

impl<E, T> RefUnwindSafe for Client<E, T> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<E, T> Sync for Client<E, T> where
E: Sync,
T: Sync,

impl<E, T> Unpin for Client<E, T> where
E: Unpin,
T: Unpin,

impl<E, T> UnwindSafe for Client<E, T> where
E: UnwindSafe,
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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